Dynamic device matching using driver candidate lists

ABSTRACT

A method and mechanism for automatically correlating a device to its appropriate driver and family within a computer system utilizing candidate matching. A device tree indicating devices coupled to a computer system is available from an operating system. Within the device tree are device nodes which specify a particular device&#39;s name (device name) and a property which indicates compatible device names (compatible names) to the particular device. Drivers and corresponding families for devices can be located in RAM, ROM, or in another storage media (such as disk drive). Drivers can include a data field indicating a driver name indicative of a corresponding device with which they operate. For a particular device, the system constructs a candidate list of drivers by comparing (1) the device name and (2) the compatible names from the device tree against all the driver names of data fields of all known drivers. The candidate list is sorted so that matches by device name and proper version number are higher priority. Corresponding families are then determined and loaded. The system then sequentially attempts installation of the drivers from the candidate list to the particular device (based on priority order) to determine the appropriate driver (e.g., probing the device using diagnostic operations). Drivers are skipped that cause an error or that do not properly configure the device. The process can be repeated for all devices in the computer system. The process is dynamic in that it is operable on boot up and upon any system change that allows more drives to be recognized.

This application is a continuation-in-part of patent application Ser. No. 08/435,676, which was filed on May 5, 1995, now U.S. Pat. No. 5,630,076 and is entitled: Dynamic Device Matching Using Driver Candidate Lists.

BACKGROUND OF THE INVENTION

(1) Field of the Invention

The present invention relates to the field of device operability with regard to devices of a computer system. More specifically, the present invention relates to the field of device and driver compatibility within a computer system for device configuration.

(2) Prior Art

Computer systems are composed of a variety of different components or "devices" that operate together to form the resultant system. Typically, some of the devices are supplied with the computer system initially, such as a central processing unit and a communication bus, and some devices can be installed into the computer system after the initial configuration of the system. In any event, in the general case, each device has an associated driver that, among other functions, configures the device and allows the device to be operable within the overall system. Drivers are typically software instructions that can be loaded into the computer system's memory and when executed will communicate with the device to properly configure the device for operation. The driver may initialize the device so that the device can function and the driver may also allow the device to communicate normally within the overall system. Normal communication within the overall system typically includes input/output (I/O) of information between a device and another part of the system; this communication includes I/O requests such as the I/O requests described in copending patent application Ser. No. 08/435,677, which was filed on May 5, 1995, and is entitled: Method and Apparatus for Handling I/O Requests, and which is hereby incorporated by reference. Since installed devices can be altered and since new devices can be inserted into a configured computer system, it becomes important to match the proper driver to the proper device for reliable operation of the computer system.

In the past, devices were matched with their proper driver by strict one to one correspondence that was typically manually performed by the computer system user. That is to say, the computer system user would alter the contents of a system file that was read at computer "boot" and this system file would contain a list of drivers that the computer system recognized and would associate a particular driver to a particular device according to an inflexible listing. The driver first needed to be loaded into the computer system before the system file was updated by the computer user so that the system would recognize the driver. This system is referred to herein as "hard coding" the drivers to their associated devices. While workable in some respects for knowledgeable computer users, this system is undesirable for computer users that do not have the know how to perform the proper matching between a given device and its driver or for those that do not know the location of the proper driver. It would be desirable, then, to provide a mechanism and method for reducing problems associated with configuring the proper driver with its associated device in a computer system. The present invention provides such advantageous solution.

In a particular systems, a PCI (Peripheral Component Interconnect) standard is adopted wherein a device driver name can be associated with a device. This name can be placed inside the device's memory. However, the PCI standard does not require that each device provide a name for the its associated driver. Therefore, there is not a guaranteed one to one correspondence between a device name and its associated driver for all system devices. If a driver does not provide its own driver name, then the system constructs a pseudo name using the device vender information and also the device type. However, this vender information and device type might correspond to more than one device. In such case, a driver might correspond to more than one device but will only operate with one device. This unfortunate case increases the difficulty in properly assigning a device to its driver. What is needed is a mechanism and method that overcomes the above problem. The present invention provides such solution.

Accordingly, it is an object of the present invention to provide a mechanism and method for efficiently and effectively correlating a computer system device with its proper device driver. It is an object of the present invention to provide the above with an automatic procedure that determines an appropriate driver, from among a set of drivers, for a particular device of a computer system. It is also an object of the present invention to perform the above for all devices of the computer system. It is yet another object of the present invention to utilize the above to facilitate computer users in configuring computer systems after a modification thereof that might involve adding or altering a computer system device which would then require a device driver update. These and other objects of the present invention will become clear within discussions of the present invention presented herein.

SUMMARY OF THE INVENTION

A method and mechanism are described for automatically correlating a device to its appropriate driver within a computer system utilizing candidate matching. A device tree indicating devices coupled to a computer system is available from an operating system. Within the device tree are device nodes which specify a particular device's name (device name) and a property which indicates compatible device names (compatible names) to the particular device. Drivers for devices can be located in RAM, ROM, or in another storage media (such as disk drive). Drivers can include a data field indicating a driver name indicative of a corresponding device with which they operate and a data field indicating a service category of the family with which they belong. In one embodiment, for a particular device, the system constructs a candidate list of drivers by comparing the device name and the compatible names from the device tree against all the driver names of data fields of all known drivers. In addition, the corresponding family code, which provides an interface to the driver code, is determined for each driver candidate by comparing the service category contained in the category information of the driver to a set of family names indicative of the available families. The candidate list is sorted so that matches by device name and proper version number are higher priority. The system then sequentially attempts installation of the drivers from the candidate list to the particular device (based on priority order) to determine the appropriate driver (e.g., probing the device using diagnostic operations). Drivers are skipped that cause an error or that do not properly configure the device. The process can be repeated for all devices in the computer system. The process is dynamic in that it is operable on boot up and upon any system change that allows more drivers to be recognized by the computer system.

Alternative embodiments of the present invention include, in a computer system having a processor coupled to a communication bus, a memory unit coupled to the communication bus, and devices coupled to the communication bus, a method for configuring a particular device of the devices, the method comprising the computer implemented steps of: reporting a set of device names associated with the particular device; scanning a first set of available drivers within the computer system to determine a second set of drivers individually having a driver name that matches with any name of the set of device names (including a compatible device name); sorting the second set of drivers by a priority of compatibility with the particular device; sequentially attempting installation of individual drivers of the second set of drivers with the particular device to determine a first matching driver of the second set of drivers that properly configures the particular device; and installing the first matching driver with the particular device upon an indication by the step of sequentially attempting installation. Embodiments of the present invention include the above and wherein the a set of device names associated with the particular device comprises a device name of the particular device and a set of compatible device names indicating devices compatible with the particular device.

Alternative embodiments of the present invention include the above and wherein the step of sorting the second set of drivers by a priority of compatibility with the particular device comprises the computer implemented steps of: sorting the second set of drivers such that an individual driver matching with the device name is given higher priority over an individual driver matching with a compatible device name of the set of compatible device names; and sorting the second set of drivers according to driver version information. Embodiments of the present invention include the above and wherein the step of sequentially attempting installation comprises the computer implemented steps of: probing the particular device with a particular driver of the second set of drivers; performing a diagnostic test with respect to the particular driver and the particular device; and reporting a status indicating whether or not the particular driver and the particular device are compatible.

Alternative embodiments of the present invention include the above and further comprising the computer implemented steps of: scanning a third set of available drivers within the computer system to determine a fourth set of drivers having a driver name that matches with either the device name or any name of the set of compatible names, the forth set larger than the second set; and sorting the forth set of drivers by a priority of compatibility with the particular device; sequentially attempting installation of individual drivers of the forth set of drivers with the particular device to determine a second matching driver of the forth set of drivers that properly configures the particular device, the second matching driver being more compatible with the device over the first matching driver; removing the first matching driver from the particular device; and installing the second matching driver with the particular device.

Embodiments of the present invention also include a computer system implemented in accordance with the above.

A portion of the disclosure of this patent document contains material which is subject to copyright protection. The copyright owner has no objection to the facsimile reproduction by anyone of the patent document or the patent disclosure, as it appears in the Patent and Trademark Office patent file or records, but otherwise reserves all copyright or mask work rights whatsoever. Copyright Apple Computer, Inc.

BRIEF DESCRIPTION OF THE DRAWINGS

FIG. 1 is a block diagram illustration of a computer system used by embodiments of the present invention.

FIG. 2 is an illustration of a device tree database of I/O devices and communication buses used by the present invention.

FIG. 3 illustrates a relationship between the present invention Driver Loader Library (DLL), the Code Fragment Manager (CFM), the computer system's operating system and the computer system firmware.

FIG. 4 illustrates information contained in a particular device node of the device tree.

FIG. 5a is an illustration of pertinent sections of a typical device driver used by the present invention including data section structure.

FIG. 5b is an illustration of pertinent sections of a typical family utilized by one embodiment of the present invention.

FIG. 6 illustrates relationships of the Device Manager ("a generic family"), the ROM, and the DLL of the present invention.

FIG. 7 is an illustration of functionality groups of the DLL of the present invention, including loading an installation of drivers.

FIG. 8 illustrates a flow diagram (logic) of a procedure of the present invention for performing driver matching against a particular device using candidate lists.

FIG. 9a illustrates a flow diagram (logic) of procedure of the present invention for constructing a candidate list for a particular device indicated in the device tree database.

FIG. 9b illustrates a flow diagram (logic) of procedure of the present invention for determining corresponding families.

FIG. 9c illustrates a flow diagram (logic) of procedure of the present invention for selecting a driver.

FIG. 10 illustrates a flow diagram (logic) of procedure of the present invention for sorting a candidate list of a particular device indicated in the device tree database.

FIG. 11 illustrates a flow diagram (logic) of an alternative embodiment of the invention for sequentially applying drivers of a candidate list to a particular device associated with that list to automatically determine an appropriate driver for the particular device.

DETAILED DESCRIPTION OF THE INVENTION

The present invention includes an apparatus and method for automatically determining a driver and corresponding family for a particular device coupled within a computer system. In the following detailed description of the present invention numerous specific details are set forth in order to provide a thorough understanding of the present invention. However, it will be obvious to one skilled in the art that the present invention may be practiced without these specific details. In other instances well known methods, procedures, components, and circuits have not been described in detail as not to unnecessarily obscure aspects of the present invention. Some portions of the detailed descriptions which follow are presented in terms of procedures and symbolic representations of operations on data bits within a computer memory. These procedure descriptions and representations are the means used by those skilled in the data processing arts to most effectively convey the substance of their work to others skilled in the art. Unless specifically stated otherwise as apparent from the following discussions, it is appreciated that throughout the present invention, discussions utilizing terms such as "processing" or "computing" or "calculating" or "determining" or "displaying" or the like, refer to the action and processes of a computer system (e.g., see FIG. 1), or similar electronic computing device, that manipulates and transforms data represented as physical (electronic) quantities within the computer system's registers and memories into other data similarly represented as physical quantities within the computer system memories or registers or other such information storage, transmission or display devices.

I. COMPUTER SYSTEM

Procedures of the present invention to be described to follow operate within the environment of a computer system 120 as shown with reference to FIG. 1. An exemplary computer system is of the Macintosh line by Apple Computer, Inc. of Cupertino, Calif., however any number of other commercially available computer systems can effectively operate the procedures of the present invention and therefore come within the scope of the present invention.

Generally, the computer system 120 comprises a bus 100 for communicating information, a central processor (CPU) 101 coupled with the bus for processing information and command instructions, a random access memory (RAM) 102 coupled with the bus 100 for storing information and instructions for the central processor 101, a read only memory (ROM) 103 coupled with the bus 100 for storing static information and command instructions for the processor 101, a data storage device 104 such as a magnetic disk or optical and disk drive coupled with the bus 100 for storing information and command instructions, and a display device 105 coupled to the bus 100 for displaying information to the computer user. A portion of the ROM 103 contains "firmware" utilized by the computer system for performing certain system tasks. The computer system's operating system software 30 (FIG. 3) can reside in the RAM 102, in the ROM 103 or within both. Portions of the operating system 30 can also reside in other data storage mediums such as the data storage device 104.

There is also an alphanumeric input device 106 in the system 120 in FIG. 1 including alphanumeric and function keys coupled to the bus 100 for communicating information and command selections to the central processor 101, a cursor control device 107 coupled to the bus for communicating user input information and command selections to the central processor 101 based on hand movement, and an input and output device 108 coupled to the bus 100 for communicating information to and from the computer system 120. The signal generation device 108 includes, as an input device, a high speed communication port configured to receive and transmit information.

The display device 105 utilized with the computer system 120 of the present invention may be a liquid crystal device, cathode ray tube, or other display device suitable for creating graphic images and alphanumeric characters recognizable to the user. The cursor control device 107 allows the computer user to dynamically signal the two dimensional movement of a visible symbol or cursor on a display screen of the display device 105. Many implementations of the cursor control device are known in the art including a trackball, mouse, joystick or special keys on the alphanumeric input device 105 capable of signaling movement of a given direction or manner of displacement. It is appreciated that the computer chassis 110 may include the following components of the present invention: the processor 101, the ROM 103, the RAM 102, the data storage device 104, and the signal input and output communication device 108 and optionally a hard copy printing device.

II. DEVICE TREE DATABASE

FIG. 2 illustrates a logical representation of a simplified and exemplary device tree 10 database recognized by the present invention. This device tree 10 is a database stored in computer memory as is a hierarchical tree composed of device nodes such as noes 1Oa-10k. This device tree 10 is constructed during the initialization of the operation system 30 (e.g., during "boot") and may be altered thereafter. A number of different procedures can be used within the present invention to generate a listing of devices coupled within the computer system 120. One such procedure is the IEEE P. 1275 firmware procedure that is used by one embodiment of the present invention. The device tree 10 database begins as a single root node 10a that represents the CPU's memory bus. All I/O buses and attached devices are assumed to descend from this single root or "node" 10a. Layers descending the device tree 10 database are dependent on the operation of devices associated with nodes above them. Buses are parent nodes and devices for the leaf nodes of the device tree 10. A complete device tree 10 represents the device topology of the computer system 20. A bus node in the device tree represents an I/O address space. Each device on a bus operates within the address space supported by its parent bus. Buses also contain information regarding interrupts, so that a device can request service from a driver. It is appreciated that drivers of the present invention are matched to devices, but not to buses. In the device tree 10, buses can lead to other buses. A node of the device tree 10 that corresponds to a device is called a "device node." Devices added to the computer system 120 will be added to the device tree 10 upon initialization of the computer system 120. Devices can contain drives, such as the disk drive 104 can store drives in a device driver folder.

The present invention used information described above in a Name registry which is essentially a copy of pertinent information obtained from the device tree 10 database. Therefore, discussions herein refer to the name registry 10 and the device tree 10 synonymously.

Referring to FIG. 2 and FIG. 3, an exemplary device tree 10 that can be used by the present invention is generated by firmware 20 upon the initialization of the computer system 120. While a portion of the information contained in the device tree 10 is utilized by the present invention, the actual (complete) copy of the device tree 10 as generated by the firmware need to be used. At system initialization, devices communicate their presence to firmware 20 which cooperates with the operating system 30 to construct the device tree 10. Information of the device tree 10 used by the present invention can be constructed under the IEEE P. 1275 Standard which is well known in the art and is not described herein. The device tree 10 database can be modified by the computer system's operating system 30 from time to time as required or instructed. As will be described further below, procedures of one embodiment of the present invention within a driver loader library (DLL) 45 operate within the environment of a Code Fragment Manager 40 (CFM). The DLL 45 operation is described in terms of the functionality described herein. It is readily apparent to one skilled in the art that the DLL can be implemented a variety of ways following the teachings of the present invention. The CFM 40 used by the present invention is described in more detail in a publication entitled Inside the Macintosh "PowerPC System Software," by Apple Computer, Inc., published by Addison-Wesley Publishing Company, February 1994, (see specifically chapter three). One of ordinary skill in the art would understand the relationship between the firmware 20, the operating system software 30, and the CFM 40 as described in the above cited reference. An embodiment of the present invention utilizes this relationship shown in FIG. 3.

With reference to FIG. 4, each device node 10a-10k of the device tree 10 database is presented to the operating system 30 and drivers by associated descriptive pieces of data called properties that are within each node. A representative device node 10f is illustrated. All device nodes of the device tree 10 database have a property that indicates the name 50 of the particular device (e.g., device name). FIG. 4 illustrates the name property as "Device Name" 50. It is this name 50 property that form a primary basis for matching a driver to a device under embodiments of the present invention. In an exemplary embodiment of the present invention, a name property 50 consists of a null-terminated string of characters. Device nodes may also contain a property that indicates compatible devices 60a to device name 50. FIG. 4 illustrates this property as "Compatible Property" 60 which provides a listing 60a of compatible names (e.g., name1, name2, and name3) of devices that are compatible with the "device name" 50. These names 60a represent devices that are compatible with the device indicated by the device name 50. These compatible names 60a are also used by the present invention to match drivers with devices should no driver match to a device name 50 for a particular device node 10f. Device nodes 10f can also contain other properties, for instance "Other Property" 70 includes information regarding interrupts (IRQ) 70a associated with the device indicated by the "device name" 50 as stored in the node 10f.

In the discussion to follow, device driver 80 or "native device drivers" and families with respect to a particular, exemplary, implementation of one embodiment of the present invention within an exemplary environment. It is appreciated that the present invention may operate on a variety of environments within a variety of different hardware and software platforms and to this extent, the disclosed particular embodiment should not be construed as limiting the scope present invention to any particular environment or platform.

III. NATIVE DEVICE DRIVERS

Under the present invention, native device drivers 80 (or just "drivers") are stored in several locations within the computer system 120. A driver 80 (FIG. 5a) can be located in RAM 102, ROM 103 (e.g., within expansion ROM located on the device itself), in a file system (e.g., on a disk drive 104), or may be directly located within a device node 10a-10k in the device tree 10 database. In the latter case device matching is not typically required for a device node having the driver associated therewith unless a more compatible driver is located elsewhere. For the majority of cases the device node does not have the driver associated with it in the device tree 10. The present invention automatically matches up a device of the device tree 10 with its appropriate driver. The drivers located in the device tree 10 are sometimes called default drivers and are said to exist within device driver property for the node. Drivers located in the file system 104 are referred to as drivers in a "device driver folder" and can override the default driver under the present invention by use of candidate list matching and candidate list priority sorting as described to follow.

Pertinent contents of an exemplary driver 80 are shown in FIG. 5a. A driver 80 within the present invention contain two sections: (1) a data section 80a; and (2) a code section 80b. The data section 80a contains a driver description data structure which does contain a "driver name" 80c. This driver name 80c can be specific to a particular device or can contain a generic name applicable to a class or group of devices. Also contained within the driver description data structure are (1) version information regarding the version of the driver code 80b and also (2) category information indicating type of device for which the driver is to be used (e.g., disk driver, video card, etc.). As will be discussed below, the category information is used to select the corresponding family. The driver name 80c of the driver description data structure 80a can be a generic driver name (e.g., NDRV) in the event the driver is compatible with a number of different devices. Also included in the driver 80 is a code section 80b containing the instructions that are used to properly configure the associated device for integration within the computer system 120.

It is appreciated that in the event that a device 80 does not contain a device name 80c, the operating system 30 or firmware 20 will generate a pseudo name for the device that consists of (1) a vender indicator known by the driver and (2) the driver type indicating the use of the device used by the driver (e.g., video card, disk drive, etc.). During initialization of the computer system 120, devices not having device names generally communicate this pseudo name to the IEEE P. 1275 procedure so the device tree 10 database will create a device node having the pseudo name. As will be described further below, the present invention provides candidate list matching procedures to account for the condition wherein more than one coupled device communicates the same pseudo name to the device tree 10 database and more than one driver in the system also contains this name.

Discussions to follow describe a format and implementation of a device drivers 80 as shown in FIG. 5a within the environment of a particular software system. It is to be appreciated that the present invention driver 80 can be implemented in a number of different environments and the implementation to follow is exemplary only and should not be construed as limiting of the scope of the present invention.

Native device drivers 80 (operable for example on the PowerPC platform) are Code Fragment Manager 40 (CFM) fragments with the following general features: (1) CFM container format; (2) CFM programming interfaces exported from the driver to Mac OS; and (3) CFM programming interfaces imported by the driver from an operating system, such as the Mac OS (Macintosh Operating System). Generic drivers are CFM fragments that work with the Device Manager 90 (FIG. 6) and the Driver Loader Library 45. The container format for native PowerPC device drivers 80 is the container format supported by the Code Fragment Manager 40 (FIG. 7). The CFM format provides all mechanisms necessary for drivers, is integrated with Mac OS, and is documented in a publication entitled Inside Macintosh: PowerPC System Software.

Native drivers, both generic and family, export a data symbol that characterizes the driver's functionality and origin. A family is a collection of devices that provide the same kind of functionality. A family can also be "generic" (e.g., Device Manager). This symbol, called TheDriverDescription 80a, is exported through the CFM's symbol mechanism. Driver Description information helps match drivers with devices. It also permits the Device Manager 95 to pick the best driver among multiple candidates. For example, it lets a newer driver on disk override a ROM-based driver. Native generic drivers 80 export a single code entry point, called DoDriverIO, that handles all Device Manager 95 operations. It is a selector-based entry point with command codes that specify the I/O action to be performed. The device driver can determine the nature of the I/O request from the command code (Initialize, Finalize, Open, Close, Read, Write, Control, Status, KillIO, Replace, or Superseded) and command kind (Synchronous, Asynchronous, or Immediate). The CFM 40 requires that fragment imports be identified in some manner. With generic drivers, this is done by linking the device driver fragment code to the Driver Services Library. The linking lets the fragment's symbols be bound at execution time. The Driver Services Library should be used instead of a Toolbox-based library when linking a device driver.

Native device drivers 80 can use the CFM's import library mechanism to share code or data. With this technique, the CFM 40 creates an import library fragment when the first driver is loaded. When another driver is loaded, it establishes a connection to the existing library, letting the two drivers share code or data.

The Device Manager 95 is part of a system software 30 that provides communication between applications and devices. The Device Manager 95 calls generic device drivers and it does not manipulate devices directly. Generic drivers accept calls from the Device Manager 95 and either cause device actions or respond by sending back data generated by devices. For further general information about drivers and the Device Manager 95, see Inside Macintosh: Devices, by Apple Computer, Inc. The Device Manager 95 has traditionally been the gateway for device drivers to use the Macintosh Toolbox, for example.

The following discussion describes, in one embodiment, the workings of a native driver 80 of the present invention under the Device Manager in the Macintosh environment ("generic family"). In one embodiment, a native driver 80 receives its parameters through the single DoDriverIO entry point, subject to the calling conventions specified by the PowerPC runtime architecture, in one embodiment. If a DoDriverIo procedure is written in C (for example), the correct behavior is guaranteed. A native driver does not have access to its Driver Control Entry (DCE) in the Unit Table. IhmediateIOCommandKind is passed in the ioKind parameter to specify that a request must be executed immediately. If so, the driver must process the request completely and the result of the process must be reflected in the return value from the driver. Initialize, Finalize, Open, Close, KillIO, Replace, and Superseded calls are always immediate. If the ioKind parameter is either SynchronousIOCommandKind or AsynchronousIOCommandKind, the return value from the driver is ignored. The driver calls IOCommandIsComplete at some future time. The Initialize and Finalize commands are sent to the driver as its first and last commands. Initialize gives the driver information it needs to start up. Finalize informs the driver that the system needs to unload it. Drivers receive all Open and Close calls, which connect the driver independently of initialization and finalization. Native drivers accept and respond to all command codes. The Read₋₋ Enable, write₋₋ Enable, Control₋₋ Enable, and Status₋₋ Enable bits in the DCE are ignored. Native drivers must keep track of I/O permissions for each instance of multiple open actions and return error codes if the permissions are violated.

The Device Manager 95 processes zero-length reads and writes on behalf of the driver. The Code Fragment Manager 40 sends CFM initialization and termination calls to a driver when the driver is loaded and unloaded. The CFM initialization procedure, if present, will run prior to the driver being initialized by the Device Manager. It is possible that the driver will be loaded and its CFM initialization procedure run even though it is never opened and, therefore, never closed. It is important that any processing done by a CFM initialization procedure be undone by the CFM termination procedure. The Device Manager 90 may load a number of drivers looking for the best candidate for a particular device. Only the best driver is opened and remains loaded. All other CFM connections are closed, causing the CFM termination procedure to run. Native drivers 80 do not jump to the IODone procedure. To finish processing an I/O request, a generic native driver calls IOCommandIsComplete to notify the Device Manager 90 that a given request has been completed.

To determine the kind of request or kind of command, the Device Manager 95 parameter block has procedure parameters called theCode and theKind. A native driver is reentrant to the extent that during any call from the driver to IOCommandIsComplete the driver may be reentered with another request. A native device driver does not have any sort of header. It will however, export a data symbol called TheDriverDescription. A driver uses this data structure to give header like information to the Device Manager. The Device Manager 90 uses the information in TheDriverDescription to set the dCtlFlags field in the driver's DCE. A native device driver cannot make use of the dCtlEMask and dCtlMenu fields of its driver control block. Native drivers 80 are not used for creating desk accessories.

The following discussion illustrates exemplary driver structures that can be utilized within the present invention. The Native Driver package is a CFM code fragment. It can reside in RAM or in a device tree 10 as a property. In one exemplary implementation it may reside in the Macintosh ROM 103, in a PCI expansion ROM 103, or in the data fork of a file 104. File-based native driver code fragments contain no resource fork and have a file type of `ndrv`. The Native Driver package may house various types of drivers. The driver is expected to support services defined for the particular device family. One predefined driver type is a generic type and is called `ndrv` (not to be confused with the Native Driver file type `ndrv`). The Native Driver package requires that at least one symbol be defined and exported by the CFM's export mechanism. This symbol must be named TheDriverDescription 80a and it is a data structure that describes the driver's type, functionality, and characteristics.

Depending on the type of driver, additional symbols must be exported. The generic `ndrv` driver type requires that the CFM package export a single code entry point, DoDriverIO, which passes all driver I/O requests. DoDriverIO must respond to the Open, Close, Read, Write, Control, Status, KillIO, Initialize, Finalize, Replace, and Superseded commands. Native drivers must also keep track of I/O permissions for each instance of multiple open actions and return error codes if permissions are violated. Other driver types that support device families must export the symbols and entry points defined by the device family or device expert.

Driver Description Structure

A device driver presents the operating system 30 with a self-describing data structure called a driver description ("DriverDescription") 80a. As shown below with respect to a particular embodiment, the driver description ("DriverDescription") 80a is used by matching mechanism of the DLL 45 of the present invention to (1) match devices to drivers; (2) identify devices by category of functionality; (3) provide driver name information; (4) provide driver version information; (5) provide driver initialization information; and (6) allow replacement of currently installed driver. By providing a common structure to describe drivers 80, the operating system 30 is able to regularize the mechanisms used to locate, load, initialize, and replace them. The operation system 30 treats any code fragment that exports a DriverDescription structure as a driver within the present invention. The structure DriverDescription 80a is used to match drivers with devices, set up and maintain a driver's runtime environment and declare a driver's supported services. An exemplary structure is shown below wherein the "driver name" 80c (FIG. 5) is located within the driverType information:

    ______________________________________                                         struct DriverDescription {                                                     OSType             driverDescSignature;                                        DriverDescVersion  driverDescVersion;                                          DriverType         driverType;                                                 DriverOSRuntime    driveOSRuntimeInfo;                                         DriverOSService    driverServices                                              };                                                                             typedef  struct  DriverDescription                                                                           DriverDescription;                               typedef  struct  DriverDescription                                                                           *DriverDescriptionPtr;                           enum {                                                                         kTheDescriptionSignature = 'mtej'                                                                    /*first long of                                                                DriverDescription*/                                      };                                                                             typedef UInt32 DriverDescVersion;                                              enum {                                                                         kInitialDriverDescriptor = 0/*Version 1 of DriverDescription*/                 };                                                                             Field descriptions:                                                            driverDescSignature                                                                   Signature of this DriverDescription structure; currentiy                       'mtej'.                                                                 driverDescVersion                                                                     Version of this Driver Description structure, used to                          distinguish different versions of DriverDescription that                       have the same driverDescSignature.                                      driverType                                                                            Structure that contains driver name and version.                        driverOSRuntimeInfo                                                                   Structure that contains driver runtime information,                            which determines how a driver is handled when Mac OS                           finds it. This structure also provides the driver's name to                    Mac OS and specifies the driver's ability to support                           concurrent requests.                                                    driverServices                                                                        Structure used to declare the driver's supported                               programming interfaces.                                                 ______________________________________                                    

Driver Type Structure

The DriverType structure contains the driver name 80c and version information about a driver, which is used by the present invention to match the driver to a specific device. A driver type structure is shown below:

    ______________________________________                                         struct DriverType {                                                            Str31       nameInfoStr;                                                       NumVersion  version;                                                           typedef UInt32                                                                             DeviceTypeMember;                                                  typedef struct                                                                             DriverType DriverType;                                             typedef struct                                                                             DriverType *DriverTypePtr;                                         Field descriptions:                                                            nameInfoStr                                                                             Name used to identify the driver and distinguish                               between various versions of the driver when an                                 expert is searching for drivers. This string of type                           Str31 is used to match the PCI name property in the                            Name Registry.                                                        version  Version resource used to obtain the newest driver                              when several identically-named drivers (that is,                               drivers with the same value of nameInfoStr) are                                available on disk.                                                    ______________________________________                                    

Driver Runtime Structure

The DriverOSRuntime structure contains information that controls how the driver is used at run time as shown below:

    ______________________________________                                         struct DriverOSRuntime {                                                       RuntimeOptions    driverRuntime;                                               Str31             driverName;                                                  UInt32            driverDescReserved 8!;                                       };                                                                             typedef    OptionBits     RuntimeOptions;                                      typedef    struct DriverOSRuntime                                                                        DriverOSRuntime;                                     typedef struct DriverOSRuntime *DriverOSRuntimePtr;                            enum {          /*DriverOSRuntime bit constants*/                              kdriverIsLoadedUponDiscovery                                                                   = 1,/*auto-load driver when                                                    discovered*/                                                   kdriverIsOpenedUponLoad                                                                        = 2, /*auto-open driver when                                                   it is loaded*/                                                 kdriverIsUnderExpertControl                                                                    = 4, /*I/O expert handles                                                      loads and opens*/                                              kdriverIsConcurrent                                                                            = 8, /*supports concurrent                                                     request*/                                                      kdriverQueuesIOPB                                                                              = 0 × 10 /*Device Manager 90 does not                                    queue IOPB*/                                                   };                                                                             Field descriptions                                                             driverRuntime   Options used to determine runtime                                              behavior of the driver. The bits in this                                       field have these meanings:                                     BitMeaning                                                                                   0 system loads driver when driver is                                           discovered                                                                     1 system opens driver when driver is                                           loaded                                                                         2 device family expert handles driver                                          loads and opens                                                                3 driver is capable of handling con-                                           current requests                                                               4 the Device Manager 90 does not                                               queue the IOPB to the DCE request                                              before calling the driver.                                       driverName      Driver name used by Mac OS if driver                                           type is ndrv. Mac OS copies this name                                          to the name field of the DCE. This field                                       is unused for other driver types.                              driverDescReserved                                                                             Reserved for future use.                                       ______________________________________                                    

Driver Services Structure

The DriverOSService structure describes the services supported by the driver that are available to applications and other software. Each device family has a particular set of required and supported services. A driver may support more than one set of services. In such cases, nServices should be set to indicate the number of different sets of services that the driver supports, see below:

    ______________________________________                                         struct DriverOSService {                                                       ServiceCount          nServices;                                               DriverServiceInfo     service 1!                                               };                                                                             typedef UInt32 ServiceCount;                                                   typedef struct DriverOSService DriverOSService;                                typedef struct DriverOSService *DriverOSServicePtr;                            Field descriptions                                                             nServices                                                                             The number of services supported by this driver. This field is                 used to determine the size of the service array that follows.           service                                                                               An array of DriverServiceInfo structures that specifies the                    supported programmning interface sets.                                  ______________________________________                                    

Driver Services Information Structure

The DriverServiceInfo structure describes the category, type, and version of a driver's programming interface services.

    ______________________________________                                         struct DriverServiceInfo {                                                     OSType             serviceCategory;                                            OST,vpe            serviceType;                                                NumVersion         serviceVersion;                                             };                                                                             typedef     struct DriverServiceInfo                                                                      DriverServiceInfo;                                  typedef     struct DriverServiceInfo                                                                      *DriverServiceInfoPtr;                              enum {                 /*used in                                                                      serviceCategory*/                                       kServiceCategoryDisplay = 'disp',                                                                     /*display*/                                             kServiceCategoryopentransport = 'otan',                                                               /*open transport*/                                      kServiceCategoryblockstorage = 'blok',                                                                /*block storage*/                                       kServiceCategorySCSISim = 'scsi',                                                                     /*SCSI SIM*/                                            kServiceCategoryndrvdriver = 'ndrv'                                                                   /*generic*/                                             };                                                                             Field descriptions:                                                            serviceCategory Specifies driver support services for given device             family.                                                                               Some examples of device families are:                                          Name Supports services defined for:                                            'blok'          block drivers family                                           'disp'          video display family                                           'ndrv'          gneric native driver                                                           devices                                                        'otan'          Open Transport                                                 'scsi'          SCSI interface module                                   serviceType                                                                             Subcategory (meaningful only in a given service                                category).                                                            serviceVersion                                                                          Version resource ('vers') used to specify the version                          of a set of services. It lets interfaces be modified over                      time.                                                                 ______________________________________                                    

DoDriverIO Entry Point

Generic `ndrv` drivers must provide a single code entry point DoDriverIO, which responds to Open, Close, Read, Write, Control, Status, KilIIO, Initialize, Finalize, Replace, and Superseded commands.

    ______________________________________                                         OSErr DoDriverIO                                                                           (AddressSpaceID)                                                                              spaceID                                                         IOCommandID    ID,                                                             IOCommandContents                                                                             contents,                                                       IOCommandCode  code,                                                           IOCommandKind  kind);                                              typedef KernelID AddressSpaceID;                                               spaceID    The address space containing the buffer to be pre-                             pared. Mac OS 7.5 provides only one address space,                             so this field must be specified as                                             kCurrentAddressSpaceID.                                             ID         CommandID                                                           contents   An IOCommandContents I/O parameter block. Use                                  the InitializationInfo union member when calling to                            initialize the driver, FinalizationInfo when removing                          the driver, DriverReplaceInfo when replacing,                                  DriverSupersededInfo when superseding, and                                     ParmBlkPtr for all other I/O actions.                               code       Selector used to determine I/O actions.                             kind       Options used to determine how I/O actions are per-                             formed. The bits in this field have these meanings:                            Bit             Meaning                                                        0               synchronous I/O                                                1               asynchronous I/O                                               2               immediate I/O                                       ______________________________________                                    

DoDriverIO Parameter Data Structures

The data types and structures that the DoDriverIO entry point uses have the following declarations:

    ______________________________________                                         typedef UInt32    IOCommandID;                                                 enum {                                                                         kInvalidID = 0                                                                 };                                                                             union IOCommandContents {                                                                      /*Contents are command specific*/                              ParmBlkPtr      pb;                                                            DriverInitInfoPtr                                                                              initialInfo;                                                   DriverFinalInfoPtr                                                                             finalInfo;                                                     DriverReplaceInf oPtr                                                                          replaceInf o;                                                  DriverSupersededInfoPtr                                                                        supersededInfo;                                                };                                                                             typedef union IOCommandContents IOCommandContents;                             typedef UInt32 IOCommandCode;                                                  enum{           /*'ndrv' driver services*/                                     kOpenCommand,   /*open command*/                                               kCloseCommand,  /*close command*/                                              kReadCommand,   /*read command*/                                               kWriteCommand,  /*write command*/                                              kControlCommand,                                                                               /*control command*/                                            kStatusCommand, /*status command*/                                             kKillIOCommand, /*kill I/O command*/                                           kInitializeCommand,                                                                            /*initialize command*/                                         kFinalizeCommand,                                                                              /*finalize command*/                                           kReplaceCommand,                                                                               /*replace driver command*/                                     kSupersededCommand                                                                             /*driver superseded command*/                                  };                                                                             typedef UInt32 IOCommandKind;                                                  enum{                                                                          kSynchronousIOCommandKind = 1,                                                 kAsynchronousIOCommandKind = 2,                                                kImmediateIOCommandKind = 4                                                    };                                                                             struct DriverInitInfo {                                                        DriverRefNum  refNum;                                                          RegEntryID    deviceEntry;                                                     };                                                                             struct DriverFinalInfo {                                                       DriverRefNum  refNum;                                                          RegEntryID    deviceEntry;                                                     };                                                                             typedef struct    DriverInitInfo                                                                            DriverInitInfo,                                                                *DriverInitInfoPtr;                               typedef struct    DriverInitInfo                                                                            DriverReplaceInfo,                                                             *DriverReplaceInfoPtr;                            typedef struct    DriverFinalInfo                                                                           DriverFinalInfo,                                                               *DriverFinalInfoPtr;                              typedef struct    DriverFinalInfo                                                                           DriverSupersededInfo,                                                          *DriverSupersededInfoPtr;                         struct InitializationInfo {                                                    refNum        refNum;                                                          RegEntryID    deviceEntry;                                                     };                                                                             struct FinalizationInfo {                                                      refNum        refNum;                                                          RegEntryID    deviceEntry;                                                     };                                                                             ______________________________________                                    

Getting Command Information

Any command in progress that the Device Manager 90 has sent to a native driver can be examined using GetIOCommandInfo.

    ______________________________________                                         GetIOCommandInfo                                                               OSErr GetIOCommandInfo                                                                         (IOCommandID  theID,                                                           IOCommandContents                                                                            *theContents,                                                    IOCommandCode *theCommand,                                                     IOCommandKind *theKind);                                       theID      Command ID                                                          theContents                                                                               Pointer to the IOPB or Initialize/Finalize contents                 theCommand Command code                                                        theKind    Command kind (synchronous, asynchronous, or                                    immediate)                                                          ______________________________________                                    

GetIOCommandInfo returns information about an active native driver I/O command. It will not work after a driver has completed a request.

    ______________________________________                                         typedef  struct  InitializationInfo                                                                          InitializationInfo;                              typedef  struct  InitializationInfo                                                                          *InitiaiizationInfoPtr;                          typedef  struct  FinalizationInfo                                                                            FinalizationInfo;                                typedef  struct  FinalizationInfo                                                                            *FinalizationInfoPtr;                            ______________________________________                                    

Responding to Device Manager 95 Requests

Native drivers 80 respond to Device Manager 95 requests by handling a single call, doDriverIO. Native drivers 80 must also keep track of I/O permissions for each instance of multiple open actions and return error codes if permissions are violated. The DoDriverIO call interface is described in the above discussion. The following sections discuss some of the internal procedures a driver 80 uses to service DoDriverIO requests.

Initialization and Finalization Routines

The Device Manager 95 sends Initialize and Finalize commands to a native driver as its first and last commands. The Initialize command gives the driver startup information and the Finalize command informs the driver that the system would like to unload it. Open and Close actions are separate from initialization and finalization rather than using Open and Close calls as the initialization and finalization mechanism. A typical framework for a generic driver handler for Device Manager 95 finalization and CFM initialization and termination commands is shown below:

    ______________________________________                                         refNum      MyReferenceNumber;                                                 RegEntryID  MyDeviceID;                                                        OSErr DoInitializeCommand                                                                  (refNum myRefNum, regEntryIDPtr myDevice)                                //Remember our refNum and Registry Entry Spec                                  MyReferenceNumber = myRefNum;                                                  MyDeviceID = *myDevice;                                                        return noErr;                                                            }                                                                              OSErr DoFinalizeCommand                                                                    (refNum myRefNum, RegEntryIDPtr myDevice)                          {                                                                              #pragma unused (myRefNum, myDevice)                                                  return noErr;                                                            }                                                                              CFMInitialize ()                                                               {                                                                                    return noErr;                                                            }                                                                              CFMTerminate ()                                                                {                                                                                    return noErr;                                                            }                                                                              ______________________________________                                    

The driver's initialization procedure first check the device's AAPL, address property to see that needed resources have been allocated. The initialization code also allocates any private storage the driver requires and place a pointer to it in the static data area that the Code Fragment Manager 40 provides for each instance of the driver. After allocating memory, the initialization procedure performs any other preparation required by the driver. If the handler fails to allocate memory for private storage it returns an appropriate error code to notify the Device Manager 95 that the driver did not initialize itself.

In an exemplary embodiment, if the Open Firnware FCode in the device's expansion ROM 103 does not furnish either a driver, AAPL, MAacOS, PowerPC property or a unique name property, or if the driver's PCI vendor-id and device-id properties are generic, then the initialization procedure checks that the device is the correct one for the driver. If the driver has been incorrectly matched, the initialization procedure must return an error code so the Device Manager 95 can attempt to make a match. The driver's finalization procedure must reverse the effects of the initialization procedure by releasing any memory allocated by the driver, removing interrupt handlers, and canceling outstanding timers. If the finalization procedure cannot complete the finalization request it can return an error result code. In any event, however, the driver will be removed.

Open and Close Routines

A native device driver 80 utilizes both an open procedure and a close procedure. The current system software does not require that these procedures perform any specific tasks, however, the driver should keep track of open calls to match them with close calls. Open and close procedures are immediate. Typical code for keeping track of open and close commands is shown below:

    ______________________________________                                         long myOpenCount;                                                              OSErr DoOpenCommand (ParmBlkPtr thePb)                                                 myOpenCount++;                                                                 return noErr;                                                          }                                                                              OSErr DoCloseCommand (ParmBlkPtr thePb)                                        {                                                                                      myOpenCount--;                                                                 return noErr;                                                          }                                                                              ______________________________________                                    

Read and Write Routines

Driver read and write procedures implement I/O requests. These procedures can execute synchronously or asynchronously. A synchronous read or write procedure must complete an entire I/O request before returning to the Device Manager 95, an asynchronous read or write procedure can begin an I/O transaction and then return to the Device Manager 95 before the request is complete. In this case, the I/O request continues to be executed, typically when more data is available, by other procedures such as interrupt handlers or completion procedures. Below is an example listing:

    ______________________________________                                         short   myLastErr;  /* Globals */                                              long    myLastCount;                                                           OSErr DoReadCommand                                                                            (IOpb pb)                                                      long numsytes;                                                                 short myErr;                                                                   numbytes = pb -> IORegcount;                                                           {                                                                                          /* do the read into pb -> iobuffer */                              }                                                                      myLastErr = myErr;                                                                             /* store in globals */                                         return (myErr);                                                                }                                                                              ______________________________________                                    

Control and Status Routines

Control and status procedures are normally used to send and receive driver-specific information. Control and status procedures can execute synchronously or asynchronously. Below shows a sample control procedure.

    ______________________________________                                         DoControlCommand.                                                              MyDriverGlobalsPtr  dStore;                                                    OSErr DoControlCommand (ParamBlkPtr pb)                                        switch (pb->csCode)                                                            {                                                                              case kClearAll:                                                                dStore->byteCount = 0;                                                         dStore->lastErr = 0;                                                           return(noErr);                                                                 default: /* always return controlErr for unknown csCode */                     return(controlErr);                                                            }                                                                              }                                                                              ______________________________________                                    

The status procedure should work in a similar manner. The Device Manager 95 uses the csCode field to specify the type of status information requested. The status procedure should respond to whatever requests are appropriate for the driver and return the error code statusErr for any unsupported csCode value. The Device Manager 95 interprets a status request with a csCode value of 1 as a special case. When the Device Manager 95 receives such a status request, it returns a handle to the driver's device control entry. The driver's status procedure never receives this request.

KillIO Routine

Native driver KillIO procedures take the following form:

    ______________________________________                                         OSErr DoKillIOCommand (ParmBlkPtr thePb)                                       {   /*    Check internal queue for request to be killed; if found,             remove from queue and free request */                                          return noErr;                                                                  }   /* Else, if no request located */                                          return abortErr;                                                               thePb Pointer to a Device Manager parameter block                              ______________________________________                                    

When the Device Manager 95 receives a KillIO request, it removes the specified parameter block from the driver I/O queue. If the driver responds to any requests asynchronously, the part of the driver that completes asynchronous requests (for example, an interrupt handler) might expect the parameter block for the pending request to be at the head of the queue. The Device Manager 95 notifies the driver of KillIO requests so it can take the appropriate actions to stop work on any pending requests. The driver must return control to the Device Manager 95 by calling IOCommandIsComplete.

Replace and Superseded Routines

Under certain conditions, it may be desirable to replace an installed driver 80. For example, a display card may use a temporary driver during system startup and then replace it with a better version from disk once the file system is running and initialized. Replacing an installed driver is a two-step process. First, the driver to be replaced is requested to give up control of the device. Second, the new driver is installed and directed to take over management of the device. In one embodiment, two native driver commands are reserved for these tasks. The kSupersededCommand selector tells the outgoing driver to begin the replacement process. The command contents are the same as with kFinalizeCommand. The outgoing driver should take the following actions: (1) If it is a concurrent driver, it should wait for current I/O actions to finish. (2) Place the device in a "quiet" state. The definition of this state is device-specific, but it can involve such tasks as disabling device interrupts. (3) Remove any installed interrupt handlers. (4) Store the driver and the device state in the Name Registry as one or more properties attached to the device entry. (5) Return noErr to indicate that the driver is ready to be replaced. (6) The kReplaceCommand selector tells the incoming driver to begin assume control of the device. The command contents are the same as a kInitializeCommand.

The incoming driver should take the following actions: (1) Retrieve the state stored in the Name Registry and delete the properties stored by the Superseded command. (2) Install interrupt handlers. (3) Place the device in an active state. (4) Return noErr to indicate that the driver is ready to be used.

IV. FAMILY MATCHING

In one embodiment, families can be stored in several locations within the computer system 120. A family can be located in RAM 102 or in a file system (e.g. on a disk drive 104). In addition to matching a device to appropriate drivers, the present invention automatically matches a device of the device tree 10 with a corresponding family. A family consists of code which, when executed, provides a universal interface for software, such as an application program, to interface with the selected device driver of that family. Families include storage devices, sounds, display devices, etc.

Pertinent contents of an exemplary family 90 are shown in FIG. 5b. In the present embodiment, a family consists of a data section 90a and a code section 90b. The data section 90a contains a family description data structure which includes version information 90c regarding the version of the family code 90b and family service category information (i.e., category name) 90e indicating the type of device for which the family is to be used (e.g., disk, video card, etc.)

Discussions to follow describe a format and implementation of a family 90 as shown in FIG. 5b within the environment of a particular software system. It is to be appreciated that the present invention family 90 can be implemented in a number of different environments and the implementation to follow is exemplary only and should not be construed as limiting of the scope of the present invention.

Families 90 (operable, for example on the PowerPC platform) are preferably Code Fragment Manager 40 (CFM) fragments with the following general features: (1) CFM container format; (2) CFM programming interfaces exported from the family of Mac OS; and (3) CFM programming interfaces imported by the family from an operating system, such as the Mac OS (Macintosh Operating System). The container format for families 90 is the container format supported by the Code Fragment Manager 40 (FIG. 7). The CFM format provides all mechanisms necessary for families, it integrated with Mac OS, and is documented in a publication entitled Inside Macintosh: PowerPC System Software.

The families are part of a system of software 30 that provides communication between application programs and devices. The family 90 calls device drivers and it does not manipulate devices directly. Drivers accept calls from the family 90 and either cause device actions or respond by sending back data generated by devices.

Family Description Structure

A family presents the operating system 30 with a self-describing data structure called a family description ("FamilyDescription") 90a. As shown below with respect to a particular embodiment, the family description ("familyDescription") 90a is used by matching mechanism of the DLL 45 of the present invention to match devices to families. By providing a common structure to describe families 80, the operating system 30 is able to regularize the mechanisms used to locate, load and initialize them. The operation system 30 treats any code fragment that exports a FamilyDescription structure as a family within the present invention. The structure family description 90a is used to match families with devices, set up and maintain a family's runtime environment and declare a family's supported services. An exemplary structure is shown below wherein the family name, or category name 90e (FIG. 5b) is located within the familyType information.

The family type structure contains the family name or category type 90e, which is used to match the driver to a corresponding family. The Family OS Run Time structure contains information that controls how the family is used at run time. The family description describes a number of elements including version and type information for the family.

    __________________________________________________________________________     //################################################                             Family Matching Data Structure                                                 //################################################                             /* The Family Type */                                                          enum                                                                              {                       /* High Level Family*/                              kFamilyIsHighLevel                                                                        =0,             /* Low Level Family*/                               kFamilyIsLowLevel                                                                         =1                                                                  typedef UInt32 FamilyLevel;                                                    /* Family Typing Information Used to Match Families With plug-ins an           Devices/*                                                                      struct FamilyType {                                                            FamilyLevel    familyLevel;                                                                              /* Kind of Family*/                                  OSType      familyName; /* Family Name*/                                       Num Version    version;   /* Family Version Number*/                           OSType      reserved;   /* Used by Mother Board.Expert*/                       };                                                                             typedef struct FamilyType                                                                     FamilyType;                                                     typedef FamilyType *                                                                          FamilyTypePtr;                                                  enum {                                                                         kFamilyIsLoadedAtBoot                                                                         = 0×00000001,                                                                       /*Family is loaded at the boot time*/                kFamilyIsLoadedUponDiscovery                                                                  = 0×00000002,                                                                       /* auto-load Family when discovered*/                kFamilyIsStartedAtBoot                                                                        = 0×00000004,                                                                       /* Family is initialized at boot*/                   };                                                                             typedef UInt32 FamilyOSRunTimeOptions;                                         struct FamilyOSRunTime {                                                       FamilyOSRunTimeOptions                                                                        familyRuntime;                                                                            /* Options for OS Runtime*/                          Str31          familyName /* Family's name to the OS*/                         UInt32         familyDescReserved 8!;                                                                    /* Reserved area*/                                   };                                                                             typedef struct FamilyOSRunTime                                                                FamilyOSRunTime;                                                typedef FamilyOSRunTime                                                                       FamilyOSRunTimePtr;                                             /*  The Family Description */                                                  enum {                                                                         kFamilyDescriptionSignature = `fdes`                                           };                                                                             typedef UInt32 FamilyDescVersion;                                              enum {                                                                         kInitialFamilyDescriptor = 0,                                                  KMotherBoardDescriptor = 1                                                     };                                                                             typedef UInt32 DependfencyCount;                                               struct MatchingAndDependencyInfo                                               union                                                                          {                                                                              Str31         deviceName;                                                                               /* the device name to match*/                         OSType        dependency;                                                                               /* Dependency List */                                 }u                                                                             };                                                                             typedef struct MatchingAndDependencyInfo                                                                  MatchingAndDependencyInfo;                          typedef MatchingAndDependencyInfo *                                                                       MatchingAndDependencyInfoPtr;                       struct FamilyMatchingAndDependency {                                           DependencyCount nrElements; /* Number of elements in the array*/               MatchingAndDependfencyInfo                                                                     matchingInfo 1!;                                               };                                                                             typedef struct FamilyMatchingAndDependencyInfo                                                            MatchingAndDependency;                              typedef MatchingAndDependency *                                                                           MatchingAndDependencyPtr;                           struct FamilyDescription {                                                     OSType          familyDescSignature;                                                                       /* Signature filed of this structure*/             FamilyDescVersion                                                                              familyDescVersion;                                                                         /* Version of this data of family*/                FamilyType      familyType; /* Type of Driver*/                                FamilyOSRunTime familyOSRuntime;                                                                           /* OS Runtime Requirements of family*/             FamilyMatchingAnd Dependency                                                                   familymatchingAndDependency                                                                  /* Family Dependency Info*/                      };                                                                             typedef struct FamilyDescription                                                               FamilyDescription;                                             typedef FamilyDescription *                                                                    FamilyDescriptionPtr;                                          __________________________________________________________________________

V. DRIVER LOADER LIBRARY

With reference to FIG. 6, the Driver Loader Library 45 (DLL) of the present invention is further discussed. FIG. 6 illustrates the relationships of the DLL 45, ROM 103, the Device Manager 95, and a driver 80 of the present invention. The Device Manager 95 communicates with a native driver 80 (for example, open, close, read, write, control, status, KillIO, Replace, and Superceded commands). The Device Manager 95 also communicates with the DLL 45. The DLL 45 gives commands to the native driver 80 such as Initialize and finalize commands. In one implementation, the DLL 45 is a CFM shared-library extension of the Device Manager 95 and provides services to locate, install, and remove drivers. The DLL 45 utilizes procedures of the CFM 40 for operation. The DLL 45 provides services that control aspects of driver to device matching under the present invention and also driver loading and installation. Under the present invention, driver and family loading is an automatic processes that frees drivers from having to perform device matching themselves.

FIG. 7 illustrates functions of the DLL 45 of the present invention. At logic block 200, the present invention performs driver matching and family loading which includes determination of a particular driver and family for a particular device of the device tree 10 database. In order to perform this, logic block 200 interfaces with the name registry (also called device tree 10 database) and also with RAM unit 102 and ROM unit 103. Drivers and families may be located in these memory units. The file storage 104 (where drivers may be located in the device driver and families folder) is also coupled to communicate with the logic block 200. The CFM 40 is also coupled with block 200. The DLL 45 performs driver matching and family loading in block 200 as well as device installation 210 once an appropriate driver is selected for a device. At block 220, information retrieval is performed which allows a user to retrieve particular information about a recognized driver. Also, the DLL 45 of the present invention performs driver removal at block 240. These functions will be discussed in further detail to follow.

FIG. 8 illustrates a flow diagram of processing performed by the DLL 45 of the present invention for automatically matching device drivers 80 to a particular identified or selected device of the devices reported in the device tree 10 database using candidate lists and sorting. This process is repeated for each device of the device tree 10 starting from the top and continuing downward through the tree 10. Processing 200 is invoked upon a request to locate a driver and associated family for a given or "selected" device. Processing logic 200 starts at block 305 wherein a candidate list is constructed and is associated with the selected device. This list contains a grouping of those drivers having a driver name that matches with the given device's device name or compatible device name. These drivers represent a set of drivers that perhaps will properly configure the given device. FIG. 9a illustrates the steps performed by logic block 305 in more detail.

With reference to FIG. 8, after a candidate list is constructed, the present invention flows to logic block 310 wherein the candidate list is sorted by priority ranking as to which members of the candidate list are more than likely to match with the selected device and those drivers that are less likely to match with the selected device. The steps performed by logic block 310 are further described with reference to FIG. 10. With reference to FIG. 8, after a candidate list is sorted by priority ranking, the present invention flows to logic block 600 wherein DLL determines the list of families required and installs them. Exemplary steps performed by logic block is shown in FIG. 9b. With reference to FIG. 8, at block 315 the present invention determines family requested to the DLL 45 to actually install a driver to the selected device. If installation request is made, the DLL installs the requested drives in block 210.

At block 330, the present invention instructs the operating system 30 to scan the devices of the computer system 120 to determine if all of the devices that the selected device needs to operate (the "parent devices") are present within the computer system 120. If the parent devices are present, then the selected driver can be installed. Since devices of the device tree 10 database are processed through the DLL 45 of the present invention from top to bottom, the parent devices for a particular selected device should be operational (e.g., processed through blocks 200 and 210) before the selected device is processed by the present invention. If the required parent devices are not operational yet or not present, then block 210 is avoided. If the required resources are available, then at block 210 the present invention performs an installation wherein the determined driver is installed with respect to the selected device and the device becomes active. It is appreciated that the processing of logic blocks 200 and 210 are typically performed at initialization for each device of the device tree 10 database, starting with the top node and working down the device tree 10 so that parent devices are configured first before their child devices are configured.

With reference to FIG. 9a, a flow diagram is illustrated describing the logic steps of the logic 305 of the present invention DLL 45 in constructing a candidate list of drivers for the selected device. Logic 305 starts at block 410 wherein pertinent information regarding the device nodes of the device tree 10 database are accessed for the particular device. If the particular device has an associated driver within its node of the device tree 10 (e.g., a "default driver"), processing continues because this default driver can become replaced by an updated driver depending on the priority of the drivers in the candidate list built for the selected device. At block 410, the present invention obtains the following properties: (1) the device name 50; and (2) the compatible names 60a of the selected device (see FIG. 4) located within the compatible property 60. After the information of logic block 410 is accessed, the present invention at logic block 420 then access the available drivers recognized in the system to construct a first set of drivers. These drivers may reside in the device tree 10 database, in the ROM 103, in RAM 102 and in the extensions folder (e.g., device driver folder) of the disk drive 104. At block 430, the present invention selects a first driver for comparison. This driver is the "given driver." At block 430, the candidate list for the selected device is then cleared so the new list can be created.

At logic block 440, the present invention examines the DriverDescription 80a information for this given driver to determine the driver name 80c (FIG. 5) of the given driver which is stored in the DriverDescription, in one embodiment, as the "nameinfostr field" of the deviceType structure for the given driver. Importantly, at logic block 440, the present invention performs a comparison between: (1) the device name 50 of the selected device and the driver name 80c of the given driver; and also between (2) each compatible name 60a of the selected device against the driver name 80c of the given driver. If there is a match between (1) or (2) above, then the match characteristics are recorded (e.g., was it match by (1) or by (2)) and at logic block 450, the given driver is added to the candidate list for the selected device if a match in 440 happened. It is appreciated the candidate list can be stored in RAM 102. The processing of the present invention then flows to logic block 460. If there was not a match at block 440, then the present invention flows to block 460 without adding the given driver to the candidate list.

At block 460, the present invention determines if the given driver is the last driver of the drivers discovered in block 420 (e.g., those drivers recognized by the computer system 120). If so, then the process 305 exits from block 460. If not, then logic block 460 is exited and processing flows to block 470 wherein the present invention selects the next driver of the set of drivers discovered in block 420. This next driver is then the "given driver" and processing returns to block 440 to determine if this next given driver should be added to the selected device's candidate list. As with any driver, the next driver selected at block 470 can reside in RAM 102, in an extension ROM 103 within the device tree 10, or within a file on the disk 104. At the completion of process 305, an unsorted candidate list is then constructed for the selected driver and is stored in RAM 102.

With reference to FIG. 10, the logic steps of logic block 310 are illustrated. Block 310 performs the candidate list sorting for a particular candidate list associated with the selected driver. At block 460, the candidate list for the selected device is accessed in RAM 102. This is a candidate list generated by logic 305 and is particular to the selected driver. At block 470, the present invention sorts the candidate list and places those drivers at the top or head of the candidate list that have a driver name 80c that matched with the device name 50 of the selected device. At the same time or sequentially, block 480 resolves any prioritization ties by using version information stored in the driver description between drivers of the candidate list. Those drivers with a more appropriate version (e.g., highest version or version closest to the selected driver) are placed higher in the candidate list priority. Block 470 then places in lower priority those drivers having a driver name 80c that matched with the selected driver's compatible names 60a. Again, version information (in logic block 480) with respect to these drivers is used to perform prioritization the same as discussed above. At the completion of block 480, the candidate list for the selected device is sorted by priority of most likely for validation (e.g., most likely to be compatible with the selected device).

With reference to FIG. 9b, the logic steps of logic block 600 of the present invention are illustrated. Block 600 performs a procedure to find suitable families for the matching drivers and installing them. Once the families are installed, the installation of drivers in the sorted candidate list is attempted. At logic step 610, the present invention accesses the sorted candidate list for a particular device. At block 620, the present invention accesses or "gets" the first driver of this candidate list. At block 630, the present invention reads the category information from the driver descriptor 80a. At block 640, the present invention checks if the category is already required by the drivers processed previously. If the test return "yes", the present invention flows to block 660 otherwise it goes to block 650. At block 650, the present invention adds the category information to the list of categories required in flows to block 660. At block 660, the present invention determines if the selected driver was the last driver of a selected candidate list of the selected device. If not, the processing flows to block 670 wherein the present invention selects the next driver in sequential order from the sorted candidate list of the selected device. Processing then flows back to block 630.

Preferably, when all the drivers in the selected list are processed, processing flows to block 680 wherein the present invention finds a matching family either in RAM unit or 102 or the file storage 104. During the matching in block 640, the DLL compares the category information read in block 650 to the category name of the family 90a. If more than one family for the same category is present, DLL selects the family with the higher version number in 90a (FIG. 5b). At block 690, the present invention loads and installs the families found in block 680. During the installation phase, families attempt to install the best driver candidate for the particular device. The steps performed to select the best driver are further defined in FIG. 9c.

With reference to FIG. 9c, the logic steps of logic block 690 of the present invention are illustrated. Block 690 performs a procedure of attempted installation of the drivers of the candidate list for the particular device (e.g., a trial and error approach based on the prior information compiled by the present invention). At logic step 510, the present invention accesses the sorted candidate list for the particular device. At block 520, the present invention accesses or "gets" the first driver of this candidate list. At block 530, the present invention attempts to install this selected driver with the selected device to validate the match. The selected driver validates the match by probing the device and performing some diagnostic operations between the selected driver and the device. Any number of different diagnostic operations can be used within the scope of the present invention for this step. Assuming the selected driver is appropriate, at logic block 540, the selected driver confirms the validation by returning a "no error" status flag to the DLL 45. If an error status was returned, or the "no error" status fails to return, then processing flows to logic block 570 wherein the present invention determines if the selected driver was the last driver of the selected candidate list for the selected device. If not, processing flows to block 560 wherein the present invention selects the next driver in sequential (e.g., priority) order from the sorted candidate list of the selected device. Processing then flows back to block 530 to determine if the next driver will validate the match with the selected device.

At block 570, if the selected driver happens to be the last driver of the sorted candidate list, then at block 580, the present invention returns an error code indicating that no compatible driver could be found for the selected device. Returning to block 540, the present invention flows to logic 550 if the selected driver did indeed match with the selected device. At block 550, the selected driver's category information is then compared against the category information of the selected device which is stored in the device tree 10 as property information. If no match is performed between the categories, then the match is not validated, so processing returns to logic block 570. If the categories match, then at block 555, the selected driver is said to be determined and a proper validation of the match occurs between it and the selected device. This information is then returned from block 320.

The operating system 30 can utilize the above logic of the present invention at various times, but in one embodiment it is used during the boot phase and at any time a new device is added to the device tree 10 (which can also add new drivers to the available list of drivers used by the present invention). It is appreciated that as the system boots and new devices are configured and "wake up" and are added to the device tree 10 (by IEEE P.1275), it is possible for a device to be assigned a driver via the present invention and then re-assigned a newer or more appropriate driver later as they become available during the boot phase. In other words, drivers located on the hard disk are not available until the hard disk itself becomes configured as a device. In such case, the scope of drivers available at block 420 (FIG. 9a) of the present invention is dynamic during the boot phase and will increase as soon the as hard drive is properly configured. In this example, a particular device can be initially configured with a driver from ROM and subsequently can be reconfigured with a more appropriate driver from the driver folder of the hard drive because the new driver will become higher in the candidate list (over the old driver) upon subsequent processing of the particular device by the present invention. Therefore, the candidate lists for a particular device are dynamic in that they will grow depending on the set of drivers that are available within the computer system 120 and recognized by the present invention.

More specifically, the processing for matching a driver with a particular device can operate at a first time given a first set of drivers recognized by the system. A high priority driver from a first candidate list can then be determined from the present information. Later, at some subsequent time a new, larger set of device drivers can become available that will lead the present invention to generate a second, updated candidate list which will indicate a new, more updated high priority driver. If this occurs, the present invention will remove the original high priority driver from the particular device and replace it with the updated high priority driver, see below under "Driver Replacement."

Below is a description of a particular, exemplary, embodiment of the system of the present invention service procedures and driver handling. It is appreciated that while a particular platform is presented below, the functionality of the present invention can be readily adapted to a variety of different platforms and the below discussion is exemplary only of a particular implementation.

In the boot process, open firmware creates the device tree (FIG. 2) describing the hardware devices present in the computer system. This device tree is imported in the system name registry 10 defined in FIG. 7. The system of the present invention uses the device tree in the name registry to find the devices present in the system, locate the drivers available to drive present devices and families required to control those device drivers.

During the booting process, some families may discover additional devices present in the system. After discovering such devices, the families will request service to append the device tree in the name registry with newly discovered devices. When a device is discovered (device tree created by the open firmware is treated as devices discovered by the present invention), services of the system are requested. On receipt of a service request, the system performs the following steps:

1. Scan the file storage 104 for all available device drivers and read their driver descriptor 80 in RAM 102.

2. Check the name registry for any ROM 103 drivers for the selected device. Add it to the list created in step 1.

3. Read the "name" of the selected device from the name registry.

4. Create a list of drivers which have the same name in the driver descriptor 80 as name read in step 3.

5. Sort the list of drivers created in step 4 using the version number field in the driver descriptor 80.

6. Read the "compatible" property of the selected device from the name registry. This property may contain more than one value.

7. Get the next (First) value of the property read in step 6.

8. Create a list of drivers which have the same name in the driver descriptor 80 as value read in step 7.

9. Sort the list created in step 8 using version number field in the driver descriptor 80. Append this list to list previously created in step 4.

10. Repeat steps 7, 8 and 9 until there are no more values left in the property read in step 6.

11. Create "driver-ptr" property in the name registry referring to the list of drivers found in steps 4 and 9.

12. Retrieve the category information stored in the driver descriptor of all the drivers present in the list created in steps 4 and 9.

13. Sort the list created in step 12 and remove duplicate categories.

14. Scan the file storage 104 for all available families and read their family descriptor 90 in RAM 102.

15. Get the next (First) service category from the list created in step 13.

16. Find family with highest version number that have same service category as value read in step 15.

17. Load and install the family found in step 16.

18. Inform family about the selected node.

19. Repeat steps 15 and 18 until no more values left in the list created in step 13.

The following discussion is retained from the parent application (Ser. No. 08/435,676, filed May 5, 1995) and describes an embodiment of the inventions presented herein.

Loading and Unloading

In one embodiment, a driver 80 of the present invention may be loaded from any CFM container (in memory, files, or resources) as well as from a device's driver property in the Name Registry 10. The following services are provided for this purpose: (1) GetDriverMemoryFragment loads a driver from a memory range; (2) GetDriverDiskFragment loads a driver from a file; (3) FindDriverCandidates and ScanDriverCandidates prepare a list of file-based drivers that potentially match a device; (4) FindDriversForDevice finds the "best" drivers for a device, searching both ROM and disk, without making a CFM connection; (5) GetDriverForDevice finds the "best" driver for a device and returns its CFM connection ID; (6) SetDriverClosureMemory determines whether or not memory is held for a driver.

One circumstance in which FindDriversForDevice or GetDriverForDevice is required is when there is a device node in the device tree 10 that does not have an associated driver. One instance when this might happen is if a PCI card is entered in the device tree 10 after system startup. FindDriversForDevice does not create a CFM connection for the driver it finds. This service is useful if there is a need to browse potential drivers for a device without loading them. GetDriverForDevice finds the driver and creates a CFM connection for it.

In one embodiment, the successful load of a driver yields the following results: (1) a CFM ConnectionID; (2) a pointer to the Driver Description; (3) a pointer to the DoDriverIO entry point. If the driver has a CFM initialization procedure, it will be executed. The initialization procedure should return noErr to indicate a successful load. Note that multiple drivers may be loaded in order to determine the best device to driver match. Therefore, a driver's CFM initialization procedure should not allocate resources that cannot be released in its termination procedure.

GetDriverMemoryFragment

GetDriverMemoryFragment loads a code fragment driver from an area of memory.

    ______________________________________                                         OSErr GetDriverMemoryFragment                                                  (Ptr        memAddr,                                                           long        length,                                                            Str63         fragName,                                                        ConnectionID  *fragmentConnID,                                                 NuDriverEntryPointPtr                                                                        *fragmentMain,                                                   DriverDescriptionPtr                                                                         *theDriverDesc);                                                 memAddr     pointer to the beginning of the fragment in                                    memory                                                             length      length of the fragment in memory                                   fragName    optional name of the fragment                                                  (primarily used by debugger)                                       fragmentConnID                                                                             resulting CFM connectionID                                         fragmentMain                                                                               resulting pointer to DoDriverIO (may be nil)                       theDriverDesc                                                                              resulting pointer to DriverDescription                             ______________________________________                                    

Given a pointer to the beginning of a driver code fragment in memAddr and the length of that fragment in length, GetDriverMemoryFragment loads the driver. It returns the loaded driver's CFM connectionID value in fragmentConnID, a pointer to its DoDriverIO entry point in fragmentMain, and a pointer to its driver description structure in theDriverDesc.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr         0             No error                                           All CFM errors                                                                 ______________________________________                                    

GetDriverDiskFragment

GetDriverDiskFragment loads a code fragment driver from a file using the CFM search path.

    ______________________________________                                         OSErr GetDriverDiskFragment                                                    (FSSpecPtr           theFragmentSpec,                                          ConnectionID         *fragmentConnID,                                          NuDriverEntryPointPtr                                                                               *fragmentMain,                                            DriverDescriptionPtr theDriverDesc);                                           fragmentSpec   pointer to a file system specification                          fragmentConnID resultingCFM connectionID                                       fragmentMain   resulting pointer to DoDriverIO                                 driverDesc     resulting pointer to DriverDescription                          ______________________________________                                    

Given a pointer to a CFM file system specification, GetDriverDiskFragment uses the CFM search path to find and load a driver code fragment. It returns the loaded driver's CFM connectionID value in fragmentConnID, a pointer to its DoDriverIO entry point in fragmentMain, and a pointer to its Driver Description in theDriverDesc.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr         0            No error                                            fnfErr       -43           File not found                                      All CFM errors                                                                 ______________________________________                                    

FindDriverCandidates

    ______________________________________                                         OSErr FindDriverCandidates                                                     (RegEntryIDPtr      deviceID,                                                  Ptr                 *propBasedDriver,                                          RegPropertyValueSize                                                                               *propBasedDriverSize,                                      StringPtr           deviceName,                                                DriverType          *propBasedDriverType,                                      Boolean             *gotPropBasedDriver,                                       FileBasedDriverRecordPtr                                                                           fileBasedDrivers,                                          ItemCount           *nFileBasedDrivers);                                       deviceID       Name Registry ID of target device                               propBasedDriver                                                                               Address of property-based driver                                propBasedDriverSize                                                                           Size of property-based driver                                   deviceName     Name of device                                                  propBasedDriverType                                                                           Type of property-based driver                                   gotPropBasedDriver                                                                            True if property-based driver was found                         fileBasedDrivers                                                                              List of sorted file-based driver records                        nFileBasedDrivers                                                                             Count of file-based driver records                              ______________________________________                                    

Given the name entry ID of a device, FindDriverCandidates constructs a candidate list of file-based drivers that match the device name 50 or one of the device-compatible names 60a. The list is sorted from best match to least favorable match. In one embodiment, drivers 80 that match the device name are listed before drivers that match a compatible name. Each of these groups are further sorted by version numbers, using the HigherDriverVersion service. Property-based drivers are always matched using the device name and are returned separately from file-based drivers. An I/O expert can determine a property-based driver's randing using the HigherDriverVersion service. If a property-based driver is not found, all outputs are zeroed. If a nil list output buffer is passed, only the count of matched file-based drivers is returned. An I/O expert can call FindDriverCandidates first with a nil buffer, allocate a buffer large enough for the list, and then call FindDriverCandidates again with the appropriately-sized buffer. If a nil value is passed in deviceID, all drivers from the Extensions folder are returned. When using this option, pass nil values for all parameters except fileBasedDrivers and nFileBasedDrivers. The list of matched drivers consists of an array of file-based driver records:

    ______________________________________                                         struct FileBasedDriverRecord {                                                 FSSpec    theSpec;    /* file specification*/                                  DriverType                                                                               theType;    /* nameInfoStr + version number*/                        Boolean   compatibleProp;                                                                            /* true if matched using a                                                     compatible name*/                                        UInt8     pad 3!;     /* aligmnent*/                                           };                                                                             typedef  struct  FileBasedDriverRecord                                         FileBasedDriverRecord, *FileBasedDriverRecordPtr;                              ______________________________________                                    

A file-based driver consists of a file specification, the driver's type, and whether the driver was matched using the device name or a compatible device name. An I/O expert can use the program logic summarized below to cycle through a list of file-based candidates.

    ______________________________________                                         FindDriverCandidates ( ); /* get list of candidates for a device*/             while (Candidates in the list)                                                 GetDriverFromFile (FSSpec-in-Record, &driverConnectionID );                    if (InitializeThisDriver(Candidate) == NotMyHardwareError) )                   {                                                                              // Unhold this failed driver's memory                                          // and Close its CFM Connection                                                UnloadTheDriver ( driverConnectionID );                                        // Advance to next position in the list.                                       GetNextCandidate( );                                                           }                                                                              else                                                                           break; // driver loaded and initialized.                                       }                                                                              RESULT CODES                                                                   noErr         0     No error                                                   fnfErr       -43    File not found                                             All CFM errors                                                                 ______________________________________                                    

ScanDriverCandidates

    ______________________________________                                         OSErr ScanDriverCandidates                                                     (RegEntryIDPtr       deviceID,                                                 FileBasedDriverRecordPtr                                                                            fileBasedDrivers,                                         ItemCount            nFileBasedDrivers,                                        FileBasedDriverRecordPtr                                                                            matchingDrivers,                                          ItemCount            *nMatchingDrivers);                                       deviceID     Name Registry ID of target device                                 fileBasedDrivers                                                                            List of sorted file-based driver records                          nFileBasedDrivers                                                                           Count of file-based driver records                                matchingDrivers                                                                             File-based driver records (a subset of                                         fileBasedDrivers)                                                 matchingDrivers                                                                             Count of driver records (<= nFileBasedDrivers)                    ______________________________________                                    

Given the name entry ID of a device and a list of FileBasedDriverRecord elements, ScanDriverCandidates constructs a list of matching file-based drivers that match the device name or one of the device-compatible names. The list is sorted from best match to least favorable match. Input to this service is an array FileBasedDriverRecord elements. Applications can use ScanDriverCandidates to match drivers from a static list of candidates without having to incur the overhead of disk I/O operations.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr         0            No error                                            fnfErr       -43           File not found                                      All CFM errors                                                                 ______________________________________                                    

FindDriversForDevice

FindDriversForDevice finds the driver from a file or from a device tree property that represents the "best" driver for a device--that is, the latest version of the most appropriate driver. The procedure for determining a best driver is described with reference to FIG. 11 of the present invention.

    ______________________________________                                         OSErr FindDriversForDevice                                                                    (RegEntryIDPtr                                                                             device,                                                            FSSpec      *fragmentSpec,                                                     DriverDescription                                                                          *fileDriverDesc,                                                   Ptr         *memAddr,                                                          long        *length,                                                           StringPtr   fragName,                                                          DriverDescription                                                                          *memDriverDesc);                                    device    device ID                                                            fragmentSpec                                                                             pointer to a file system specification                               fileDriverDesc                                                                           pointer to the Driver Description of driver in a file                memAddr   pointer to driver address                                            length    length of driver code                                                fragName  name of driver fragment                                              memDriverDesc                                                                            pointer to the Driver Description of driver in                       ______________________________________                                                   memory                                                          

Given a pointer to the RegEntrvID value of a device, FindDriversForDevice finds the most suitable driver for that device. If the driver is located in a file, it returns a pointer to the driver's CFM file system specification in fragmentSpec and a pointer to its Driver Description in fileDriverDesc. If the driver is a fragment located in memory, FindDriversForDevice returns a pointer to its address in memAddr, its length in length, its name in fragName, and a pointer to its Driver Description in memDriverDesc.FindDriversForDevice initializes all outputs to nil before searching for drivers.

    ______________________________________                                         RESULTCODES                                                                    ______________________________________                                         noErr         0            No error                                            fnfErr       -43           File not found                                      All CFM errors                                                                 ______________________________________                                    

GetDriverForDevice

GetDriverForDevice loads the "best" driver for a device from memory. The procedure for determining the best driver for a selected device is described in with reference to FIG. 11.

    ______________________________________                                         OSErr GetDriverForDevice                                                                     (RegEntrvIDPtr                                                                               device,                                                          ConnectionID  *fragmentConnID,                                                 DriverEntrvPointPtr                                                                          *fragmentMain                                                    DriverDescriptionPtr                                                                         *driverDesc);                                      device    device ID                                                            fragmentConnID                                                                           pointer to a fragment connection ID                                  fragmentMain                                                                             pointer to DoDriverIO                                                driverDesc                                                                               pointer to the Driver Description of driver                          ______________________________________                                    

Given a pointer to the RegEntrvID value of a device, GetDriverForDevice loads from memory the most suitable driver for that device. It returns the loaded driver's CFM connectionID value in fragmentConnID, a pointer to its DoDriverIO entry point in fragmentMain, and a pointer to its Driver Description.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr         0            No error                                            fnfErr       -43           Filenotfound                                        All CFM errors                                                                 ______________________________________                                    

SetDriverClosureMemory

    ______________________________________                                         OSErr SetDriverClosureMemory                                                   (CFragConnectionID  fragmentConnID,                                            Boolean             holdDriverMemory);                                         fragmentConnID                                                                            ID of driver closure (returned from other DLL                                  loading services)                                                   holdDriverMemory                                                                          true to hold the memory of a driver closure; false to                          unhold.                                                             ______________________________________                                    

In one embodiment, a driver 80 and all its libraries is called a driver closure. When a driver 80 is loaded and prepared for initialization by the DLL, memory for its closure may be held as the final step in implementing GetDriverMemoryFragment and GetDriverDiskFragment. SetDriverClosureMemory lets one do this by setting the holdDriverMemory parameter true. SetDriverClosureMemory can also be use to free memory held for a driver closure by setting the holdDriverMemory parameter false. To undo the effects of GetDriverMemoryFragment or GetDriverDiskFragment, an I/O expert can call SetDriverMemoryClosureMemory (cfmID, false) followed by CloseConnection (&cfmID). This has the effect of unloading the driver. Listing below shows a sample procedure to perform this task.

    ______________________________________                                         void UnloadTheDriver ( CFragConnectionID fragID )                              OSErr    Status;                                                               THz      theCurrentZone                                                                             = GetZone ( );                                            // Make sure the fragment is attached to the system context                    // (System 7.5.2 CFM keys context from the current heap zone)                  SetZone (SystemZone ( ));                                                      Status = SetDriverClosureMemory (fragID, false);                               if (Status |= noErr)                                                           printf ("Couldn't unhold pages of Driver Closure|                              (Err==%x)\n",Status);                                                Status = CloseConnection (&fragID);                                            if (Status |= noErr)                                                           printf ("Couldn't close Driver Connection|                                     (Err==%x)\n", Status);                                               // Reset the zone                                                              SetZone ( theCurrentZone );                                                    }                                                                              ______________________________________                                    

Installation

Once loaded, a driver must be installed in a Unit Table (stored in memory) to become available to Device Manager clients ("applications"). This process begins with a CFM fragment connection ID and results in a refNum. The installing software can specify a desired range of unit numbers in the Unit Table. For example, SCSI drivers use the range 32 to 38 as a convention to their clients. If the driver cannot be installed within that range, an error is returned. The Unit Table grows to accommodate the new driver as well.

In one embodiment, the unit table may grow only if the unit number is between some defined number (for example 48) and the current highest unit number as returned by the HighestUnitNuntber procedure. When installing a native driver, the caller also passes the RegEntryIDPtr of the device which the driver is to manage. This pointer (along with the refNum) is given to the driver as a parameter in the initialization command. The driver may use this pointer to iterate through a device's property list, as an aid to initialization. The native driver should return noErr to indicate a successful initialization command. These functions, described in the below, operate on a loaded driver fragment: (1) verifyFragmentAsDriver verifies fragment contents as driver; (2) InstallDriverFromFragment places a driver fragment in the Unit Table; (3) InstallDriverFromDisk places a disk-based driver in the Unit Table; and (4) OpenInstalledDriver opens a driver that is already installed in the Unit Table

VerifyFragmentAsDriver

VerifyFragmentAsDriver guarantees that there is a driver in a given fragment.

    ______________________________________                                         OSErr VerifyFragmentAsDriver                                                   (ConnectionID        fragmentConnID,                                           NuDriverEntryPointPtr                                                                               * fragmentMain,                                           DriverDescriptionPtr *driverDesc);                                             fragmentConnID CFM connectionID                                                fragmentMain   resulting pointer to DoDriverIO                                 driverDesc     resulting pointer to DriverDescription                          ______________________________________                                    

Given a CFM connectionID value for a code fragment, VerifyFragmentAsDriver verifies that the fragment is a driver. It returns a pointer to the driver's DoDriverIO entry point in fragmentMain and a pointer to its Driver Description in driverDesc.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr         0             No error                                           All CFM errors                                                                 ______________________________________                                    

InstallDriverFromFragment

InstallDriverFromFragment installs a driver fragment in the Unit Table.

    ______________________________________                                         OSErr InstallDriverFromFragment                                                        (ConnectionID                                                                               fragmentConnID,                                                   RegEntryIDPtr                                                                               device,                                                           UnitNumber   beginningUnit,                                                    UnitNumber   endingUnit,                                                       refNum       *refNum);                                                 fragmentConnID                                                                               CFM connectionID                                                 device        pointer to Name Registry specification                           beginningUnit low unit number in Unit Table range                              endingUnit    high unit number in Unit Table range                             refNum        resulting Unit Table refNum                                      ______________________________________                                    

InstallDriverFromFragment installs a driver that is located in a CFM code fragment, using the standard code fragment search path, anywhere within the specified unit number range of the Unit Table. It invokes the driver's Initialize command, passing the RegEntryIDPtr to it. The driver's initialization code must return noErr for InstallDriverFromFragment to complete successfully. This function returns the driver's refNum but it does not open the driver. If the requested Unit Table range is from the determined number (e.g., 48) to the highest unit number currently available, as returned by the HighestUnitNumber procedure, and if that range is currently filled, the Unit Table will expand to accept the new driver. If the Device Manager 90 has already enlarged the Unit Table to its maximum possible size, however, InstallDriverFromFragment will return unitTbIFullErr.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr       0        No error                                                  badUnitErr -21       Bad unit number                                           unitTblFullErr                                                                            -29       Unit table or requested range full                        Specific returns Initialize, Replace, Superseded                               All CFM errors                                                                 ______________________________________                                    

InstallDriverFromDisk

InstallDriverFromDisk locates a file in the Extensions folder that is in the Mac OS System folder, verifies that the file's contents are a native driver, and loads and installs the driver.

    ______________________________________                                         OSErr InstallDriverFromDisk                                                    (Ptr         driverName,                                                       RegEntryIDPtr                                                                               device,                                                           UnitNumber   beginningUnit,                                                    UnitNumber   endingUnit,                                                       DriverRefNum *refNum);                                                         driverName                                                                              Name of a disk file containing a driver                               device   Pointer to entry in the Name Registry                                 beginningUnit                                                                           First Unit Table number of range acceptable for                                installation                                                          endingUnit                                                                              Last Unit Table number of range acceptable for                                 installation                                                          refNum   Reference number returned by InstallDriverFromDisk                    ______________________________________                                    

InstallDriverFromDisk installs a driver that is located on disk 104 anywhere within the specified unit number range of the Unit Table and invokes the driver's Initialize command, passing the RegEntryIDPtr to it. The driver's initialization code must return noErr for InstallDriverFromDisk to complete successfully. This function returns the driver's refnum but it does not open the driver. If the requested Unit Table range is from the determined number (e.g., 48) to the highest unit number currently available, as returned by the HighestUnitNumber procedure, and if that range is currently filled, the Unit Table will expand to accept the new driver. If the Device Manager 90 has already enlarged the Unit Table to its maximum possible size, however, InstallDriverFromDisk will return unitThlFullErr.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr       0        No error                                                  fnfErr     -43       File not found                                            badUnitErr -21       Bad unit number                                           unitTblFullErr                                                                            -29       Unit table or requested range full                        All CFM errors                                                                 ______________________________________                                    

OpenInstalledDriver

OpenInstalledDriver opens a driver that is already installed in the Unit Table.

    ______________________________________                                         OSErr OpenInstalledDriver                                                      (DriverRefNum                                                                               refNum,                                                           SInt8        ioPermission);                                                    refNum  Unit Table reference number                                            ioPermission                                                                           I/O permission code:                                                   fsCurPerm     0 retain current permission                                      fsRdPerm      1 allow read actions only                                        fsWrPerm      2 allow write actions only                                       fsRdWrPerm    3 allow both read and write actions                              ______________________________________                                    

Given an installed driver's Unit Table reference number, OpenInstalledDriver opens the driver. The Device Manager 90 ignores the ioPermission parameter; it is included only to provide easy communication with the driver.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr        0           No error                                              badUnitErr  -21          Bad unit number                                       unitEmptyErr                                                                               -22          Empty unit number                                     ______________________________________                                    

Load and Install Option

Callers wishing to combine the loading and installation process in one service may want to use one of the following functions, described in the next sections: (1) InstallDriverFromFile loads and installs a file-based driver; and (2) InstallDriverFromMemory loads and installs a memory-based driver

InstallDriverFromFile

InstallDriverFromFile loads a driver from a file and installs it.

    ______________________________________                                         OSErr InstallDriverFromFile                                                                    (FSSpecPtr   fragmentSpec,                                                     RegEntryIDPtr                                                                               device,                                                           UnitNumber   beginningUnit,                                                    UnitNumber   endingUnit,                                                       refNum       *refNum);                                         fragmentSpec                                                                             pointer to a file system specification                               device    pointer to Name Registry Specification                               beginningUnit                                                                            low unit number in Unit Table Range                                  endingUnit                                                                               high unit number in Unit Table Range                                 refNum    resulting Unit Table refNum                                          ______________________________________                                    

InstallDriverFromFile installs a driver that is located on disk 104 anywhere within the specified unit number range of the Unit Table and invokes the driver's Initialize command, passing the RegEntryIDPtr to it. The driver's initialization code must return noErr for InstallDriverFromFile to complete successfully. This function returns the driver's refNum but it does not open the driver.

If the requested Unit Table range is from the determined number (e.g., 48) to the highest unit number currently available, as returned by the HighestUnitNumber procedure, and if that range is currently filled, the Unit Table will expand to accept the new driver. If the Device Manager has already enlarged the Unit Table to its maximum possible size, however, InstallDriverFromFile will return unitTblFullErr.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr       0        No error                                                  fnfErr     -43       File not found                                            badUnitErr -21       Bad unit number                                           unitTblFullErr                                                                            -29       Unit table or requested range full                        All CFM errors                                                                 ______________________________________                                    

InstallDriverFromMemory

InstallDriverEromMemory loads a driver from a range of memory and installs it.

    ______________________________________                                         OSErr InstallDriverEromMemory                                                           (Ptr      memory,                                                              long      length,                                                              Str63     fragName,                                                            RegEntryIDPtr                                                                            device,                                                              UnitNumber                                                                               beginningUnit,                                                       UnitNumber                                                                               endingUnit,                                                          refNum    *refNum);                                                   memory      pointer to beginning of fragment in memory                         length      length of fragment in memory                                       fragName    An optional name of the fragment                                               (primarily used by debugger)                                       device      pointer to Name Registry specification                             beginningUnit                                                                              low unit number in Unit Table range                                endingUnit  high unit number in Unit Table range                               refNum      resulting Unit Table refNum                                        ______________________________________                                    

InstallDriverFromMemory installs a driver that is located in a CFM code fragment, using the standard code fragment search path, anywhere within the specified unit number range of the Unit Table. It invokes the driver's Initialize command, passing the RegEntryIDPtr to it. The driver's initialization code must return noErr for InstallDriverFromMemory to complete successfully. This function returns the driver's refNum but it does not open the driver. If the requested Unit Table range is from the determined number (e.g., 48) to the highest unit number currently available, as returned by the HighestUnitNumber procedure, and if that range is currently filled, the Unit Table will expand to accept the new driver. If the Device Manager has already enlarged the Unit Table to its maximum possible size, however, InstallDriverFromMemory will return unitTblFullErr.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr       0        No                                                        badUnitErr -21       Bad unit number                                           unitTblFullErr                                                                            -29       Unit table or requested range full                        All CFM errors                                                                 ______________________________________                                    

Match, Load and Install

Those wishing to combine the matching of the best driver for a device, with the loading and installation process in one service, may use InstallDriverForDevice and HigherDriverVersion, described in this section. The DriverDescription data structure is used to compare a driver's functionality with a device's needs as discussed above. The Driver Loader Library picks the best driver for the device by looking for drivers in the Extensions folder (device driver folder) and comparing those against drivers in the device's property list.

InstallDriverForDevice

InstallDriverForDevice installs the "best" driver for a device. The procedure for determining the best driver is described in FIG. 11.

    ______________________________________                                         OSErr InstallDriverForDevice                                                   (RegEntryIDPtr device,                                                         UnitNumber     beginningUnit,                                                  UnitNumber     endingUnit,                                                     refNum         *refNum);                                                       device        pointer to Name Registry specification                           beginningUnit low unit number in Unit Table range                              endingUnit    high unit number in Unit Table range                             refNum        resulting Unit Table refNum                                      ______________________________________                                    

InstallDriverForDevice finds, loads, and installs the best driver for a device identified by its RegEntryID value. In one embodiment, it installs the driver anywhere within the specified unit number range of the Unit Table and invokes its Initialize command, passing the RegEntryIDPtr to it. The driver's initialization code must return noErr for InstallDriverForDevice to complete successfully. This function returns the driver's refNum but it does not open the driver. If the requested Unit Table range is from the determined number (e.g., 48) to the highest unit number currently available, as returned by the HighestUnitNumber procedure, and if that range is currently filled, the Unit Table will expand to accept the new driver. If the Device Manager 90 has already enlarged the Unit Table to its maximum possible size, however, InstallDriverForDevice will return unitTblFullErr.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr       0        No error                                                  fnf Err    -43       File not found                                            badUnitErr -21       Bad unit number                                           unitTblFullErr                                                                            -29       Unit table or requested range full                        All CFM errors                                                                 ______________________________________                                    

HigherDriverVersion

HigherDriverVersion compares two driver version numbers, normally the values in their DriverDescription structures. It returns a value that indicates which driver is later. This service may be used by any software that loads or evaluates drivers.

    ______________________________________                                         short HigherDriverVersion (NumVersion *V1, NumVersion *V2);                    struct NumVersion {                                                            UInt8 majorRev;                                                                               /*1st part of version number in BCD*/                           UInt8 minorAndBugRev;                                                                         /*2nd and 3rd part of version number                                           share a byte*/                                                  UInt8 stage;   /*stage code: dev, alpha, beta, final*/                         UInt8 nonRelRev;                                                                              /*rev level of non-released version*/                           };                                                                             V1   First version number being compared                                       V2   Second version number being compared                                      ______________________________________                                    

HigherDriverVersion returns 0 if v1 and v2 are equal. It returns a negative number if V1<V2 and a positive number greater than 0 if V1>V2. If both drivers have stage values of final, a nonRelRev value of 0 is evaluated as greater than any nonzero number.

Stage codes are the following:

    ______________________________________                                                   developStage                                                                           = 0×20                                                           alphaStage                                                                             = 0×40                                                           betaStage                                                                              = 0×60                                                           finalStage                                                                             = 0×80                                                 ______________________________________                                    

Driver Removal

Applications wishing to remove an installed driver can use RemoveDriver, see block 240 of FIG. 7.

RemoveDriver

RemoveDriver removes an installed driver.

    ______________________________________                                         OSErr    RemoveDriver                                                                               (refNum   refNum,                                                        Boolean Immediate);                                             refNum     refNum of driver to remove                                          Immediate  true means don't wait for driver to become idle                     ______________________________________                                    

RemoveDriver accepts a refNum and unloads a code fragment driver from the Unit Table. It invokes the driver's Finalize command. If called as immediate, it does not wait for driver to become inactive.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr        0           No error                                              badUnitErr  -21          Bad unit number                                       unitEmptyErr                                                                               -22          Empty unit number                                     ______________________________________                                    

Getting Driver Information

Applications wishing to acquire information about an installed driver can use GetDriverInformation.

GetDriverInformation

GetDriverInformation returns a number of pieces of information about an installed driver, see block 220 of FIG. 7.

    ______________________________________                                         OSErr GetDriverInformation                                                     (DriverRefNum       refNum,                                                    UnitNumber          *unitNum,                                                  DriverFlags         *flags,                                                    DriverOpenCount     *count,                                                    StringPtr           name,                                                      RegEntryID          *device,                                                   CFragHFSLocator     *driverLoadLocation,                                       CFragConnect ionID  * fragmentConnID,                                          DriverEntryPointPtr *fragmentMain,                                             DriverDescription   *driverDesc);                                              refNum       refNum of driver to examine                                       unit         resulting unit number                                             flags        resulting DCE flag bits                                           count        number of times driver has been opened                            name         resulting driver name                                             device       resulting Name Registry device specification                      driverLocation                                                                              resulting CFM fragment locator                                                 (from which the driver was loaded)                                fragmentConnID                                                                              resulting CFM connection ID                                       fragmentMain resulting pointer to DoDriverIO                                   driverDesc   resulting pointer to DriverDescription                            ______________________________________                                    

Given the Unit Table reference number of an installed driver, GetDriverInformation returns the driver's unit number in unit, its DCE flags in flags, the number of times it has been opened in count, its name in name, its RegEntryID value in device, its CFM fragment locator in driverLocation, its CFM connection ID infragmentConnID, its DoDriverIO entry point in fragmentMain, and its Driver Description in driverDesc.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr        0           No error                                              badUnitErr  -21          Bad unit number                                       unitEmptyErr                                                                               -22          Empty unit number                                     ______________________________________                                    

Searching For Drivers

The exemplary procedures described in this section help clients iterate through the Unit Table, locating installed drivers.

HighestUnitNumber

HighestUnitNumber returns the currently highest valid unit number in the Unit Table. UnitNumber HighestUnitNumber (void);

HighestUnitNumber takes no parameters. It returns a UnitNumber value that represents the highest unit number in the Unit Table.

LookupDrivers

LookupDrivers is used to iterate through the contents of the Unit Table.

    ______________________________________                                         OSErr  LookupDrivers                                                                              (UnitNumber beginningUnit,                                                     UnitNumber  endingUnit,                                                        Boolean     emptyUnits,                                                        ItemCount   *returnedRefNums,                                                  DriverRefNum                                                                               *refNums);                                      beginningUnit                                                                            First unit in range of units to scan                                 endingUnit                                                                               Last unit in range of units to scan                                  emptyUnits                                                                               true: return available units                                                   false: return allocated units                                        returnedRefNums                                                                          Maximum number of reference numbers to return; on                              completion, contains actual number of refNums                                  returned                                                             refNums   resulting array of returned refNums                                  ______________________________________                                    

Given the first and last unit numbers to scan, LookupDrivers returns the reference numbers of both native and 68K drivers. The emptyUnits parameter tells it to return either available or allocated units and returnedRefNums tells it the maximum number of reference numbers to return. When LookupDrivers finishes, returnedRefNums contains the actual number of refNums returned. The sample code shown below uses HighestUnitNumber and LookupDrivers to print out the reference numbers of all installed drivers and obtain driver information.

    __________________________________________________________________________     RESULT CODES                                                                   noErr     0         No error                                                   paramErr -50        Bad parameter                                              FindAllDrivers ( )                                                             ItemCount  theCount                                                                             = 1;                                                          UnitNumber theUnit                                                                              = 0;                                                          DriverRefNum                                                                              theRefNum,                                                                           *fullSizedRefNumBuffer;                                       // Method #1:                                                                             Iterate with a small output buffer                                  while ( (theUnit <= HighestUnitNumber( ) ) &&                                   (LookupDrivers(theUnit, theUnit, false, &theCount, &theRefNum) ==noErr)       )                                                                              {                                                                              if (theCount == 1) printf ( "Refnum;#%d is allocated. \n",           theRefNum);                                                                    theCount = 1;                                                                  theUnit++;                                                                     }                                                                              // Method #2: Get all refnums with one call                                    fullSizedRefNumBuffer = NewPtr ((HighestUnitNumber( ) + 1)*                    sizeof(DriverRefNum));                                                         theCount = (HighestUnitNumber( ) + 1);                                         LookupDrivers (0, HighestUnitNumber( ), false, &theCount,                      fullSizedRefNumBuffer);                                                        for(theUnit=0,theUnit <theCount;theUnit++)                                     {                                                                              printf("Refnum #%d is allocated.\n", fullSizedRefNumBuffer            theUnit!);                                                                    ShowDriverInfo (fullSizedRefNumBuffer  theUnit!);                              }                                                                              DisposePtr(fullSizedRefNumBuffer);                                             return noErr;                                                                  }                                                                              ShowDriverInfo (DriverRefNum *refNum)                                          {                                                                              UnitNumber   theUnit;                                                          DriverRefNum aRefNum;                                                          DriverFlags  theFlags;                                                         FSSpec       driverFileSpec;                                                   RegEntrvID   theDevice;                                                        CFragHFSLocator                                                                             theLoc;                                                           Str255       theName;                                                          CFragConnectionID                                                                           fragmentConnID;                                                   DriverOpenCount                                                                             theOpenCount                                                      DriverEntryPointPtr                                                                         fragmentMain;                                                     DriverDescription                                                                           theDriverDescription;                                             theLookuponDisk.fileSpec = &driverFileSpec;                                    GetDriverInformation                                                                        (  aRefNum,                                                                       &theUnit,                                                                      &theFlags,                                                                     &theOpenCount, theName,                                                        &theDevice,                                                                    &theLoc,                                                                       &fragmentConnID,                                                               &fragmentMain,                                                                 &theDriverDescription);                                        printf ("Driver's flags are: %x\n", theFlags);                       __________________________________________________________________________

Finding, Initializing, and Replacing Drivers

The native driver framework tolerate a wide range of variations in system configuration. Although drivers and expansion cards may be designed and updated independently, the system autoconfiguration firmware offers several techniques for making them work together. This section discusses what PCI driver and card designers can do to improve the compatibility of their products.

Device Properties

A PCI device is required to provide a set of properties in its PCI configuration space. These properties can be used in the device tree 10 database for a particular device. It may optionally supply FCode and runtime driver code in its expansion ROM. PCI devices without FCode and runtime driver code in ROM may not be used during system startup. The required device properties in PCI configuration space are: (1) vendor-ID; (2) device-ID; (3) class-code; and (4) revision-number. For PCI boot devices there must be an additional property: driver-reg, AAPL, MacOS, PowerPC. This property contains a pointer to the boot driver's image in the PCI card's expansion ROM. It is used in conjunction with the f code-rom-of f set property. The OpenFirmware FCode in a PCI device's expansion ROM (e.g., ROM 103) must provide and install a driver-reg property, as shown above, to have its driver appear in the Name Registry and be useful to the system during startup. It must also add its expansion ROM's base register to the reg property, so that system firmware can allocate address space when installing the driver.

Boot Sequence

The following is a short description of a boot sequence (e.g., for PCI standard): 1. Hardware reset. 2. Open Firmware creates the device tree. This device tree is composed of all the devices found by the Open Firmware code including all properties associated with those devices. 3. The Name Registry device tree is created by copying the Macintosh-relevant nodes and properties from the Open Firmware device tree. 4. The Code Fragment Manager and the Interrupt Tree are initialized. 5. Device properties that are persistant across system startups and are located in NVRAM are restored to their proper location in the Name Registry device tree. 6. The Name Registry device tree is searched for PCI expansion ROM device drivers associated with device nodes. 7. PCI expansion ROM device drivers required for booting are loaded and initialized. 8. If a PCI ROM device driver is marked as kdriverIsLoadedUponDiscovery, the driver is installed in the Device Manager Unit Table. 9. If a PCI ROM device driver is marked as kdriverlsOpenedUponLoad, the driver is initialized and opened, and the driver-ref property is created for the driver's device node. 10. The Display Manager is irritated. 11. The SCSI Manager is initiated. 12. The File Manager and Resource Manager are initialized. 13. Device properties that are persistent across system startups and located in the folder System Folder: Preferences are restored to their proper location in the Name Registry device tree.

Device drivers that fall under Family Expert control are processed next. The following steps load disk-based experts and disk-based drivers: 1. Scan the extensions folder for drivers, (file type `ndrv`), updating the Registry with new versions of drivers as appropriate. For each driver added or updated in the tree, a driver-description property is added or updated as well. 2. For each driver that is replaced, and already open, use the driver replacement mechanism. 3. Run `init` resources for virtual devices. 4. Scan the extensions folder for experts, (file type `expt`); load, initialize, and run the expert. 5. Run experts to scan the registry, using the driver-description property associated with each node to determine which devices are of the appropriate family. 6. Load and initialize appropriate devices based on family characteristics. At that point all devices in use by the system and family subsystems are initialized. Uninitialized and unopened devices or services that may be used by client applications are located, initialized, and opened at the time that a client makes a request for the devices or services.

Matching Drivers With Devices

The matching logic of the present invention is presented above with respect to FIG. 8 FIG. 11. In one exemplary embodiment, the DLL 45 procedures GetDriverForDevice, InstallDriverForDevice, and FindDriversForDevice use the following procedure to match or install the "best" driver for a device under the present invention: 1. Find all candidate drivers for the device to build a candidate list. A driver 80 is a candidate if its nameInfoStr value 80c matches either the device's name 50 or one of the names 60a found in the device's compatible property. 2. Sort this list based on whether the driver 80 matched using the device's name 50 or a compatible name 60a. Those matched with the device name 50 are put at the head of the candidate list. Tie are broke using the driver's version number information. 3. If not installing the driver, return the driver at the head of the candidate list and go to step 7 below. 4. While there are candidates with which to attempt an installation, do the following steps: 5. Load and install the driver located at the head of the candidate list. 6. The driver should probe the device, using DSL services, to verify the match. If the driver did not successfully initialize itself report error. 7. Discard any remaining candidates.

DeviceProbe

DeviceProbe is used to determine if a hardware device is present at the indicated address. This process can operate during block 530 of FIG. 11.

    ______________________________________                                         OSStatus    DeviceProbe  (void *theSrc,                                                                 void *theDest,                                                                 UInt32 AccessType);                                   theSrc      The address of the device to be accessed                           theDest     The destination of the contents of theSrc                          AccessType  How theSrc is to be accessed:                                                  k8BitAccess                                                                    k16BitAccess,                                                                  k32BitAccess                                                       ______________________________________                                    

DeviceProbe accesses the indicated address and stores the contents at theDest using AccessType to determine whether it should be an 8-bit, 16-bit or 32-bit access. Upon success it returns noErr. If the device is not present, e.g., if a bus error or a machine check is generated, it returns noHardwareErr. If a device such as a PCI card contains no FCode, and therefore is assigned a generic name of the form pcixxxx, yyyy, it is important for a driver to provide diagnostic code in its Initialize procedure. When a driver is matched with a card that has a generic name property, it may be the wrong driver. In that case, diagnostic code probing for a unique characteristic of the card may not only fail a data compare, but can cause a possible unrecoverable machine check exception. DeviceProbe allows a driver to explore its hardware in a recoverable manner. It provides a safe read operation, which can gracefully recover from a machine check and return an error to the caller. If DeviceProbe fails, the driver should return an error from its Initialize command. This return may cause the DLL 45 to continue its driver-to-device matching process until a suitable driver is found.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr        0           Device present                                        noHardwareErr            Device not present                                    ______________________________________                                    

Opening Devices

There is a distinction between device initialization and device opening. A device opening action is a connection-oriented response to client requests Device drivers should expect to run with multiple Open and Close commands. This means that each driver is responsible for counting open requests from clients, and must not close itself until all clients have issued close requests. Initialization can occur independently of client requests; for example at startup time, or (in the case of PCMCIA devices), when a device is hot-swapped into or out of the system. Initialization of native device driver controlled devices is handled in phases as described in the previous section. It is necessary to make a distinction here between PCI drivers and 68K drivers because the 68K driver initialization path has not changed.

In one embodiment, the first phase of native driver initialization consists of searching the device portion of the Name Registry looking for boot devices. Boot device nodes should be flagged as kdriverIsOpenedUponLoad in the DriverDescriptor property associated with the device node. These devices are loaded, initialized, and opened by the system. These drivers must be in ROM 103 and must be of service category `ndrv`. Drivers should be passive code controlled by a client--in this case, the system starting up. PCI bridges are tagged kDriverIsLoadedUponDiscovery and kDriverIsOpenedUponLoad.

In one embodiment, the second phase of startup comes after the file system is available. In this second phase the device driver folder (e.g., extensions folder) is scanned for Family Experts, which are run as they are located. Their job is to locate and initialize all devices of their particular service category in the Name Registry 10. The Family experts are initialized and run before their service category devices are initialized because the Family expert extends the system facilities to provide services to their service category devices. For example, the DisplayManager extends the system to provide VBL capabilities to `disp`service category drivers. In the past, VBL services have been provided by the Slot Manager; but with native drivers, family-specific services such as VBL services move from being a part of bus software to being a part of family software.

Driver Replacement

This section describes the mechanism to allow update of a ROM-based driver with an newer disk-based version. After the Registry is populated with device nodes, the startup sequence initializes the devices. For every device node in the Registry there are two questions that require answers before the system can complete a client request to use the device. The client may be the system itself or an application. The questions are: (1) Is there a driver for this node? (2) Where is the most current version of the driver for this node?

If there is a driver in ROM 103 for a device, the driver, AAPL, MacOS, PowerPC property is available in the Name Registry 10 whenever a client request is made to use that device. However, after the operating system is running and the file system is available, the ROM driver may not be the driver of choice. In this case, the ROM-based driver is replaced with a newer version of the driver on disk. In the system startup sequence, as soon as the file system 104 is available the operating system 30 searches the device driver folder (e.g., Extensions folder) and matches drivers in that folder with device nodes in the Name Registry. The driverInfoStr and version fields of the DriverType field of the two DriverDescriptors 80a are compared, and the newer version of the driver is installed in the tree. When the driver is updated, the DriverDescriptor property and all other properties associated with the node whose names begin with Driver are updated in the Name Registry 10.

If the driver associated with a node is open (that is, if it was used in the system startup sequence) and if the driver is to be replaced, the system must first close the open driver, using the driver-ref property in the Name Registry 10 to locate it. The system must then update the Registry and reinstall and reopen the driver. If the close or finalize action fails, the driver will not be replaced. The native driver model does not provide automatic replacement of 68K drivers (type `DRVR`). If an application needs to replace a 68K driver with a native driver dynamically, the open 68K driver is closed and its state information is extracted, and load and install the native driver using the Driver Loader Library. The native driver will occupy the same DCE slot as the 68K driver and use the same refNum. After being opened, it will start running with the state information that was extracted from the 68K driver.

Applications and other software can use the ReplaceDriverWithFragment function to replace one driver with another and RenameDriver to change a driver's name. These procedures are described next.

ReplaceDriverWithFragment

ReplaceDriverWithFragment replaces a driver that is already installed with a new driver contained in a CFM fragment. It sends replace and superseded calls to the drivers.

    ______________________________________                                         OSErr ReplaceDriverWithFragment                                                                  (DriverRefNum theRefNum,                                                       ConnectionID fragmentConnID);                                theRefNum  Reference number of the driver to be replaced                       fragment ConnID                                                                           CFM connection ID for the new driver fragment                       ______________________________________                                    

Given the Unit Table reference number of an installed driver in theRefNum, ReplaceDriverWithFragment replaces that driver with a new driver contained in a CFM fragment identified by fragmentConnID. It sends replace and superseded calls to both drivers.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr         0             No error                                           All CFM errors                                                                 ______________________________________                                    

RenameDriver

RenameDriver changes the name of a driver.

    ______________________________________                                         OSErr RenameDriver                                                                              (DriverRefNum                                                                               theRefNum,                                                        StringPtr    name);                                           theRefNum  Reference number of the driver to be renamed                        name       Pointer to the driver's new name                                    ______________________________________                                    

Given the Unit Table reference number of an installed driver in theRefNum, RenameDriver changes the driver's name to the contents of a string pointed to by name.

    ______________________________________                                         RESULT CODES                                                                   ______________________________________                                         noErr        0           No error                                              badUnitErr  -21          Bad unit number                                       unitEmptyErr                                                                               -22          Empty unit number                                     ______________________________________                                    

While the present invention has been described in particular embodiments, it should be appreciated that the present invention should not be construed as limited by such embodiments, but rather construed according to the below claims. 

What is claimed is:
 1. In a computer system having a processor coupled to a communication bus, a memory unit coupled to said communication bus, and devices coupled to said communication bus, a method for configuring a particular device of said devices with a device driver, said method comprising the computer implemented steps of:reporting a device name associated with said particular device; scanning a first set of available drivers within said computer system to determine a second set of drivers individually having a driver name that matches with said device name; for each individual driver of the second set of drivers, scanning a first set of families available within the computer system to determine a second set of families comprising at least one family, each family of the second set of families having category information which matches category information associated with the individual driver of the second set of drivers; installing at least one family of the second set of families; sequentially attempting installation of individual drivers of said second set of drivers with said particular device to determine a matching driver of said second set of drivers that properly configures said particular device; and reporting said matching driver of said set of drivers that properly configures said particular device upon an indication by said step of sequentially attempting installation.
 2. A method as described in claim 1 further comprising the computer implemented step of sorting said second set of drivers and families by a priority of compatibility with said particular device and wherein said step of sorting comprises the further computer implemented steps of:sorting said second set of drivers such that an individual driver matching with said device name is given higher priority over an individual driver matching with at least one compatible device name which is associated with said particular device; and sorting said second set of drivers according to driver version information; and selecting a family having a highest version number of the families of the second set of families.
 3. A method as described in claim 1 wherein said step of sequentially attempting installation comprises the computer implemented steps of:probing said particular device with a particular driver of said second set of drivers; performing a diagnostic test with respect to said particular driver and said particular device; and reporting a status indicating whether or not said particular driver and said particular device are compatible.
 4. A method as described in claim 1 wherein said reporting comprises the computer implemented steps of:accessing information derived from a device tree database containing information regarding said devices of said computer system; selecting said particular device from among said devices; and accessing said device name and said at least one compatible device name associated with said particular device from said information derived from said device tree database.
 5. A method as described in claim 1 further comprising the computer implemented step of installing said matching driver with said particular device provided resources are available within said computer system required for operation of said particular device.
 6. A method as described in claim 1 further comprising the computer implemented steps of:scanning a third set of available drivers within said computer system to determine a fourth set of drivers individually having a driver name that matches with said device name, said third set being more current over said first set of available drivers; and for each individual driver of the fourth set of drivers, scanning the first set of families available within the computer system to determine a third set of families comprising at least one family, each family of the third set of families having category information which matches category information associated with the individual driver of the fourth set of drivers.
 7. A method as described in claim 6 further comprising the computer implemented steps of:sequentially attempting installation of individual drivers of said fourth set of drivers and said third set of families with said particular device to determine another matching driver of said fourth set of drivers that properly configures said particular device, said another matching driver being more compatible with said device compared to said matching driver; and reporting said another matching driver upon an indication by said step of sequentially attempting installation of individual drivers of said forth set of drivers.
 8. In a computer system having a processor coupled to a communication bus, a memory unit coupled to said communication bus, and devices coupled to said communication bus, a method for configuring a particular device of said devices, said method comprising the computer implemented steps of:reporting a set of device names associated with said particular device; scanning a first set of available drivers within said computer system to determine a second set of drivers individually having a driver name that matches with any name of said set of device names; for each individual driver of the second set of drivers, scanning a first set of families available within the computer system to determine a second set of families comprising at least one family, each family of the second set of families having category information which matches category information associated with the individual driver of the second set of drivers; sorting said second set of drivers by a priority of compatibility with said particular device; installing at least one family of the second set of families; sequentially attempting installation of individual drivers of said second set of drivers with said particular device to determine a first matching driver of said second set of drivers that properly configures said particular device; and installing said first matching driver with said particular device upon an indication by said step of sequentially attempting installation.
 9. A method as described in claim 8 wherein said a set of device names associated with said particular device comprises a device name of said particular device and a set of compatible device names indicating devices compatible with said particular device.
 10. A method as described in claim 9 wherein said step of sorting said second set of drivers by a priority of compatibility with said particular device comprises the further computer implemented steps of:sorting said second set of drivers such that an individual driver matching with said device name is given higher priority over an individual driver matching with a compatible device name of said set of compatible device names; sorting said second set of drivers according to driver version information; and selecting a family having a highest version number of the families of the second set of families.
 11. A method as described in claim 8 wherein said step of sequentially attempting installation comprises the computer implemented steps of:probing said particular device with a particular driver of said second set of drivers; performing a diagnostic test with respect to said particular driver and said particular device; and reporting a status indicating whether or not said particular driver and said particular device are compatible.
 12. A method as described in claim 9 wherein said step of reporting comprises the further computer implemented steps of:accessing information derived from a device tree database containing information regarding said devices of said computer system; selecting said particular device from among said devices; and accessing said device name and said set of compatible device names associated with said particular device from said information derived from said device tree database.
 13. A method as described in claim 8 further wherein said step of installing said first matching driver comprises the further computer implemented steps of:determining that said computer system contains resources required by said particular device for proper operation; and installing said first matching driver with said particular device provided said resources required by said particular device are present within said computer system.
 14. A method as described in claim 9 further comprising the computer implemented steps of:scanning a third set of available drivers within said computer system to determine a fourth set of drivers individually having a driver name that matches with either said device name or any name of said set of compatible device names, said forth set larger than said second set; sorting said fourth set of drivers by a priority of compatibility with said particular device; and for each individual driver of the fourth set of drivers, scanning the first set of families available within the computer system to determine a third set of families comprising at least one family, each family of the third set of families having category information which matches category information associated with the individual driver of the fourth set of drivers.
 15. A method as described in claim 14 further comprising the computer implemented steps of:sequentially attempting installation of individual drivers of said forth set of drivers with said particular device to determine a second matching driver of said forth set of drivers that properly configures said particular device, said second matching driver being more compatible with said device over said first matching driver; removing said first matching driver from said particular device; and installing said second matching driver with said particular device.
 16. A computer readable medium storing instructions for a digital processing system having a processor coupled to a bus and a particular device coupled to said bus, wherein when said instructions are executed by said processor, said system is caused to perform the steps of:reporting a device name associate with said particular device; scanning a first set of available drivers within said system to determine a second set of drivers individually having a driver name that matches with said device name; for each individual driver of the second set of drivers, scanning a first set of families available within the system to determine a second set of families comprising at least one family, each family of the second set of families having category information which matches category information associated with the individual driver of the second set of drivers; installing at least one family of the second set of families; sequentially attempting installation of individual drivers of said second set of drivers with said particular device to determine a matching driver that properly configures said particular device; and reporting said matching driver of said set of drivers that properly configures said particular device upon an indication by said step of sequentially attempting installation.
 17. A computer readable medium as in claim 16 wherein when said instructions are executed, said system is caused to perform the further step of:sorting said second set of drivers and families by a priority of compatibility with said particular device and wherein said step of sorting comprises:sorting said second set of drivers such that an individual driver matching with said device name is given higher priority over an individual driver matching with at least one compatible device name which is associated with said particular device; and sorting said second set of drivers according to driver version information; and selecting a family having a highest version number of the families of the second set of families.
 18. A computer readable medium as in claim 16 wherein said step of sequentially attempting installation comprises the steps of:probing said particular device with a particular driver of said second set of drivers; performing a diagnostic test with respect to said particular driver and said particular device; and reporting a status indicating whether or not said particular driver and said particular device are compatible.
 19. A computer readable medium as in claim 16 wherein said step of reporting comprises:accessing information derived from a device tree database containing information regarding said devices of said computer system; selecting said particular device from among said devices; and accessing said device name and said at least one compatible device name associated with said particular device from said information derived from said device tree database.
 20. A computer readable medium as in claim 16 wherein said computer readable medium comprises at least one of RAM, ROM and a disk drive.
 21. A digital processing system comprising:a bus; a processor coupled to said bus; a particular device coupled to said bus; a memory coupled to said bus, said memory storing a first set of drivers and storing a first set of families, said processor scanning said first set of drivers to determine a second set of drivers comprising at least one driver that has a driver name that matches a device name associated with said particular device, said processor scanning said first set of families to determine a second set of families comprising at least one family having a category information which matches category information associated with said one driver, said processor installing said at least one family and attempting installation of said at least one driver with said particular device to determine a matching driver that properly configures said particular device.
 22. A digital processing system as in claim 21 wherein said processor sorts said second set of drivers and families by a priority of compatibility with said particular device such that an individual driver matching with said device name is given higher priority over an individual driver matching with at least one compatible device name which is associated with said particular device;and wherein said processor sorts said second set of drivers according to driver version information and selects a family having a highest version number of the families of the second set of families. 